Getting started with API Integration for Central Agents

This guide walks Central Agents through the step-by-step process of integrating their managed yachts onto their website.

Introduction

As a Central Agent you can use our Calendars App to showcase your own as well as other Yachts on your website. The steps you follow are very similar to if you were a Charter Broker and had an API integration subscription.

1. Claiming and activating your yachts

To start the process, make sure you are logged into your Calendars - Central Agent portal.

Next, make sure all the yachts you manage are claimed and active. If you require some assistance with this, follow this Guide to Claiming Yachts. When claimed, the yachts should show in the 'My Fleet' area of your account.

Double check the contents of your yachts and make any update as required before progressing to the next step. To make changes to your yacht, click on the specific yacht profile you wish to make edits to and then click 'Edit Profile'.

Once you have checked and updated the yacht information make sure the 'Active' toggle has been switched on within ALL Yacht profiles.

2. Enabling the API Integration toggle

Next, enable the API Integration toggle in your settings. This will allow calendar data to sync and include your yacht's information.

3. Request a Purchase link for API Integration

Once you have completed the amove, you can request a payment link for CA API integration form our team. Chat with one of our team using the chat feature inside the application or email support@ankor.io.

You should recieve a payment link which is where you can pay for the API integration and continue to authentificiation.

4. Authentication using API Keys

Now that you have access to the API Integration, you can go ahead and generate your public and private keys to access the Yacht data to then display on your website. Our team will assist you to generate these keys. Once generated, you can follow this guide to complete the process. The guide assumes you are working with a developer.

Still Need Help?

Speak to our Customer Success team, who are here to support you via support@ankor.io or chat with us using the Life ring Help feature at the bottom right of our application.