Welcome to the AtoBviaC Web Service.
This web service is released and available for commercial use. Billing is now enabled – distances will be deducted from your account when calling the web service with your Access Key.
You require a valid Access Key to use the service. Demo Access Keys can be created through the AtoBviaC site. A demo Access Key is typically sufficient for development purposes. If you require more information, contact support@atobviac.com.
The API documentation and a sandbox can be found below.
There is a demo project written in C# showing how to make basic use of the Web Service. You can download it from here: WebServiceDemo.zip
You should pass your access key as a querystring parameter called api_key.
Demo access keys are restricted to a limited set of ports (the "demo ports"), and points that lie within a rhumb distance of 200 nautical miles of these ports. The current set of demo ports is:
If an error occurs, two headers may be present to convey additional information.
The 'X-ABC-Error' header contains a textual description of the error.
The 'X-ABC-ErrorCode' header may be present to indicate a particular class of error, as listed in the table below.
| X-ABC-ErrorCode Value | Name | Description |
|---|---|---|
| 1000 | General Error | There is no specific class for this error. More information may be available in the X-ABC-Error header. |
| 1001 | Unreviewed Leg | The voyage contains a leg that we do not currently have a route for (there will be a route, but it has not been manually reviewed by us). A very small percentage of routes may not be available from our network. This is typically because the route is uncommon and has not been previously requested. |
| 1002 | No Route | A route cannot be obtained from the network. This is usually because of the current routing critera; additional routing points may need to be opened. The "antipiracy routing" option may need to be disabled to access ports in the piracy area. |
| 1003 | Insufficient Credits | The account associated to the supplied API key has run out of credits, so it cannot perform this calculation. |
| 1004 | Subscription Expired | The subscription for the account associated to the supplied API key has expired, so it cannot perform this calculation. |
| 1005 | Invalid Demo Voyage Point | A voyage point specified is not usable, because the provided API key is for a demo account. Demo access keys are restricted to a limited set of ports (the "demo ports"), and points that lie within a rhumb distance of 200 nautical miles of these ports. The current set of demo ports is listed above. |
| 1006 | Account Does Not Allow Specified Waypoint Resolution | The waypoint resolution for the account associated to the provided API key is lower than the resolution specified. OR: You have tried to request an RTZ file, but the account you are using does not have access to the necessary waypoint resolution. |
| 1007 | Invalid API key | No API key was supplied; or an API key was supplied, but it wasn't valid. |
| 1008 | Account Does Not Allow Point-To-Point Voyages | You tried to request a voyage that visits geographic positions, but the provided API key is for an account that does not have the "point-to-point" upgrade. (If a geographic position would be usable by a demo account – see the explanation above – then it can be used in voyages even by accounts that don't have the "point-to-point" upgrade.) |
The API currently provides one Piracy Zone called 'Piracy':
| Code | Description |
|---|
The AtoBviaC routing algorithm will return the shortest Voyage between ports.
Users can open and close Routing Points to control the Voyage that is generated.
For example, the Suez Canal can be closed by appending &close=SUZ
to your request.
| Code | Description | Default |
|---|
Users can open and close Routing Point Groups, as they do with the Routing Points,
to control the Voyage that is generated. For example, the CCC group (Cape Cod Canal)
can be closed by appending &close=CCC to your request, this will
automatically close the Routing Point members of the CCC group i.e. CCN (Cape Cod
Canal - North) and CCS (Cape Cod Canal - South).
| Code | RoutingPointShortCodes | Description |
|---|