DOKK API

Welcome to the DOKK API documentation. This guide provides all the necessary information to access and integrate with the DOKK platform's API.

Integrations

The Integrations API offers a suite of endpoints tailored for third-party developers to interact with DOKK's platform. Access to these endpoints requires an API Key, which serves as an authentication credential. You can request an API Key from our development team by contacting us at [e-mail] or submitting a request here: Support Request Form.

API Key Usage and Throttling

• Each API Key is unique and tied to an organization or developer.

• Throttling limits may apply to ensure fair usage and prevent server congestion. While we recommend limiting requests to once every 10–30 minutes, higher request frequencies may be acceptable during development and testing.

• To test the endpoints, we recommend tools like Postman.

Screenshot from Postman

Note: Refer to our 9.6 API Key Usage and Restrictions in our Terms of use for additional details on usage guidelines and policies.

Cruise Details

The Cruise Details endpoint provides a simplified view of port call schedules, abstracted from the internal calendar. It is designed for external use and is currently applicable only to Port organizations. For Agencies, a similar endpoint will be introduced soon to address their specific data requirements.

GET https://b.dokk.is/api/v1/integration/organizations/{uuid}/cruise-details/?start_date={YYYY-MM-DD}&end_date={YYYY-MM-DD}

Parameter	Type	Description
start_date	string	(Optional) Filter results starting from this date (format: YYYY-MM-DD).
end_date	string	(Optional) Filter results up to this date (format: YYYY-MM-DD).
uuid	string	Required 32 character long string.

Usage Notes

• UUID: This identifier is provided by DOKK and uniquely represents the organization.

• Date Filtering: The start_date and end_date parameters are optional and can be used to narrow down the results to a specific time range.

• Data Integrity: Results returned are subject to the accuracy and currency of the information inputted into the DOKK platform.

The response is an array of cruise details, structured as follows:

{
        "id": integer,
        "created": datetime,
        "updated": datetime,
        "arrival": datetime,
        "departure": datetime,
        "port_name": string,
        "port_locode": string,
        "voyage": string,
        "turn_around": bool,
        "turn_around_date": datetime,
        "arrival_number": string,
        "status": string,
        "last_status": string,
        "location_name": string,
        "location_color": string,
        "location_max_draught": decimal,
        "location_max_length": decimal,
        "vessel_name": string,
        "vessel_imo": integer,
        "vessel_mmsi": integer,
        "vessel_type": string,
        "vessel_flag": string,
        "vessel_build_year": integer,
        "vessel_passenger_capacity": integer,
        "vessel_crew_capacity": integer,
        "vessel_length_overall": decimal,
        "vessel_breadth_extreme": decimal,
        "vessel_draught": decimal,
        "vessel_grt": decimal,
        "vessel_owner": string,
        "agent_name": string,
        "show_booking": bool,
        "agency_organization_name": string
}