API Documentation
Getting started with Arkiway's commercial REST APIs — authentication, integration guides and reference documentation for HarborCosts and Voyage APIs.
Getting started
Four steps from commercial agreement to your first API call.
Establish a commercial agreement
Arkiway APIs are available through commercial agreements. Contact our team to discuss your integration requirements, expected volumes and access scope. We will provision a tenant and client credentials upon agreement.
Receive your client credentials
After onboarding, you will receive a client_id and client_secret for the OAuth 2.0 Client Credentials flow. These credentials identify your application and determine which API scopes are available.
Obtain an access token
Exchange your client credentials for a JWT access token by calling the token endpoint. Tokens are short-lived and should be cached until expiry to minimize authentication overhead.
Make your first API call
Include the access token as a Bearer token in the Authorization header. Call any available endpoint — for example, estimate port costs or query vessel positions — and parse the JSON response.
Authentication
Arkiway APIs use the OAuth 2.0 Client Credentials grant type — a standard machine-to-machine flow designed for server-side integrations where no user interaction is required.
Each client operates within its own tenant context. Access tokens include scope claims that determine which APIs and data sets are available. Token lifetime and rate limits are configured per agreement.
POST /oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET
&scope=harborcosts:read voyage:read{
"access_token": "eyJhbGciOiJSUzI1NiIs...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "harborcosts:read voyage:read"
}GET /v1/vessels/9876543/position
Authorization: Bearer eyJhbGciOiJSUzI1NiIs...
Accept: application/jsonAPI references
Detailed endpoint documentation for each API.
Port cost analysis, budget tracking, invoice verification and tariff intelligence.
TMS integration, cargo requests, document exchange and event webhooks for the logistics portal.
Need help integrating?
Our API team provides technical onboarding, integration support and dedicated assistance for commercial partners. Get in touch to start building on Arkiway.