FAQ - Website API

Template Overview: Understanding the key differences between each template

The Route Summary section

The Toys & Amenities section

The Yacht Crew section

The Yacht Specifications section

The Yacht Pricing section

The Top Navigation

Getting started with API Integration

FAQ - Trips

How API Integration can drive Enquiries as a Central Agent

How API Integration can drive enquiries as a Charter Broker

FAQ - Calendars

The Yacht Summary Section

Getting started with API Integration for Central Agents

Getting started with Trips

How to claim a yacht

The Headings section

Saving a Default Layout in your presentation

Create & Edit Presentations

Create & Edit Routes

The Spacing section

Manage your User Settings

Managing your locations

The Image Section

Part 2: Finalizing the Contract: Entering Details, Signing, and Distribution

The Checklist Section

The Embed Video Section

The Disclaimer Section

The Business Card Section

FAQ - Contracts

The Noticeboard

Quick start on Yachts

The Overview Section

The Additional Notes section

The Route Map section

The basic structure of a presentation

The All Day Card Section

The Hero section

Best practices for editing route content in a presentation

Updating the calendar for a yacht

Quick Start to Calendars as a Central Agent

Charter Broker Onboarding Process

Editing Your Yacht's profile

Central Agent - Set Live Process

Adding and managing tags to improve ranking search

A complete guide to your yacht's information.

How to generate a Charterer-friendly brochure for any Yacht

Yacht profile: A comprehensive overview

A summary for creating and completing a contract.

Part 1: Generating and Inputting the Contract particulars

Learn everything you need to get started with our Proposal and Itinerary builder. 

🖼️  Trips

Learn the fundamentals, best practices and more. 

Getting Started

Learn how to customise all the sections within a presentation. 

Customising your Presentation

Learn how to get started, authenticate and customise your API web integration.

🌐 API Web Integration 

Authentification

Central Agents

Charter brokers

Learn the ins and outs of our Calendars application.

📆 Calendars

Charter Brokers

Learn about our Contracts application, how to build your first contract and get answers to our frequently asked questions.

📝 Contracts

Learn about the application made for Charter brokers and doing audits of yachts

⛵ YachtNoter

Q: What is included in the yacht website integration?&nbsp; A: The fields in Appendix A are included in the yacht website integration&nbsp;Q: How often is the data updated via the API?&nbsp; A: The yacht information in Calendars is updated instantly. Your web developer also has the option of having this information update on your website feed instantly (e.g., if they avoid caching etc.). We highly advise to setup these updates to be often as we add new yachts every day, in that way you can get these yachts updated on your side as well.Q: Can I show the yacht information / imagery on social media?&nbsp; A: No, the license only covers hosting on your own website.&nbsp;Q: Do central agencies control permission to for retail brokers to show data?&nbsp; A: Yes, Central Agencies control the permission of whether their yachts can be displayed&nbsp;Q: Can Ankor do the integration work to connect the API to my website?&nbsp; A: No, but we are happy to help guide with your technical team – please see our API documentation <a href="http://api.ankor.io/">here</a>&nbsp;Q: Can I select what yachts show up on my website?&nbsp; A: Yes you can select which yachts to show on your website via your API calls.&nbsp;Q: Does having yachts on my website help with SEO?&nbsp; A: Yes, listing yachts on your website can significantly improve SEO. Yacht listings provide valuable keyword-rich content, enhance website structure, and attract potential clients, all of which are positive ranking factors.Q: Can I show live availability on my website?&nbsp; A: This is available in Ankor Calendars, but not pushed via API website integration – Please reach out if this is something we should consider including in the future.&nbsp;Q: What happens if a Central Agency removes access for yachts? A: We will inform you and give you the steps on how to remove from your website&nbsp;Q: How do we select which yachts we do and don't want to show on our website?&nbsp; A: This can be handled on your developer's end. Access to the API allows you to pull all CA-approved yachts, you may select/filter which yachts to show or not show as part of your developers implementation of the API.&nbsp;Q: If yacht information is updated by the CA in Calendars, how quickly will that update be reflected on my website&nbsp; A: If a yacht that you are displaying on your website is updated in Calendars (such as new imagery), it is possible for this update to be reflected on your website near instantly depending on how frequently your website call the API (as set by your developer)&nbsp;Q: Am I restricted to show the yachts on my website the same as how they display in Calendars?&nbsp; A: No, you will get access to certain fields of data for each yacht through the API, and you may display (or not display) these fields however you choose on your website.&nbsp;Q: How much control do I have over the design / how a yacht will look on my website?&nbsp; A: you will gain access to the yachts and all data available view the website API from Calendars – How you choose display these raw data points is completely up to you and your web development team.&nbsp;<h2>Still Need Help?&nbsp;</h2>Speak to our Customer Success team, who are here to support you via <a href="mailto:support@ankor.io">support@ankor.io</a> or chat with us using the Life ring Help feature at the bottom right of our application.&nbsp;Link to our <a href="https://www.ankor.io/terms-conditions">Terms and Conditions</a>

<h2>Introduction</h2>If you’ve just purchased a website API integration from Ankor Software, here’s a clear guide to help you or your developer get started with the authentication and protocol process. This explanation assumes you’re either a developer or assisting one, and it outlines the steps and content needed to understand and implement the API integration.<h2>What Protocol does Ankor webite API Use?&nbsp;</h2>Ankor Software Website APIs uses the <a href="https://tools.ietf.org/html/rfc6749">OAuth 2.0 protocol</a> for authentication and authorization. We supports common OAuth 2.0 for all API offering. This page gives an overview of the OAuth 2.0 authorization scenarios that Ankor supports, and provides a brief overview of the steps.<h2>1. Obtaining your API client credentials</h2>Before making any API calls, you’ll need your authentication credentials. These are provided by Ankor Software after purchase. Start by loging into Calendars and click on your 'Settings' page.&nbsp;<ol><li>To obtain your Company URI, click on 'Company Details' inside your settings page and copy the Company URI.&nbsp;</li></ol><figure class="image"><img src="https://cdn-assets.productfruits.com/99753e97-1203-459f-883b-8a3e2983fef1"></figure><ol><li>Next, click on 'Key generation' page inside settings.&nbsp;</li><li>Click on the button 'Generate'.&nbsp;</li></ol><figure class="image"><img src="https://cdn-assets.productfruits.com/877f00b4-dc74-46fe-9c3c-1ded0027770b"></figure><ol><li>A dialogue box will appear with shows your:&nbsp;<ol><li>Key ID (KID)</li><li>Private Key</li><li>Public Key</li></ol></li></ol><img src="https://cdn-assets.productfruits.com/c9dfaef5-6401-4db2-b274-0ba62149782a">&nbsp; Store them away safely. This is what will be used to generate a JWT.<h2>Pre-requisites for constructing the JWT:</h2>We use <a href="https://jwt.io/introduction">JWT</a> for authentication. There are pre-requisites to creating a JWT in-order to use the APIs.<ul><li>Header&nbsp;&nbsp; <img class="image_resized" style="width:500px;" src="https://cdn-assets.productfruits.com/b3f2ceb9-544a-4988-b461-f8860e5a6130"></li><li>Payload&nbsp; <img class="image_resized" style="width:504px;" src="https://cdn-assets.productfruits.com/a0429c7a-8017-4e32-89ac-4bc1f34d87fe">&nbsp;</li></ul><blockquote><pre><code class="language-plaintext">{
 &nbsp; "scopes": [
 &nbsp;&nbsp;&nbsp;&nbsp; "website:read:*"
],
"iss": "&lt;company_uri_here&gt;",
"aud" :"ankor.io",
"sub": "&lt;company_uri_here&gt;",
"iat": &lt;current_epoch_time&gt;,
"exp": &lt;current_epoch_time+1hr&gt;
}</code></pre></blockquote><ul><li>Scopes - Pass a valid claim set. For example,&nbsp;<ul><li>Retail Agent Website API use "website:read:*"</li><li>Central Agent Entity API use "entity:*"</li></ul></li><li>Issuer - Your company URI.</li><li>Audience - "ankor.io"</li><li>Subject - Your company URI.</li><li>Issued At - The time when this token is being issued.&nbsp;</li><li>Expiry - The time after which the token expires. Must be less than 1 hour from issued at.</li><li>Signature&nbsp; Use you PRIVATE KEY to sign the jwt.</li></ul><h3>Obtain a token from Ankor Software's Identity &amp; Access Management API</h3>To request an access token from Ankor you can refer to the <a href="https://api.ankor.io" target="_blank" rel="noopener noreferrer">API docs</a> in the IAM section. Use the generated JWT in the above step and pass it to the POST /iam/oauth/token request.&nbsp;<img class="image_resized" style="width:507px;" src="https://cdn-assets.productfruits.com/64d17330-21ae-4ed8-8ba5-866437afe677"><h2>Sending the access token in an API call</h2>On successful authentication, you will receive an access token that must be passed as a bearer to access Ankor's APIs.&nbsp;<h2>Refreshing the token</h2>Access tokens have limited lifetimes, 1 hour at most. If your application needs access beyond the lifetime of a single access token, simply obtain a new token.<h2>References</h2><a href="https://api.ankor.io" target="_blank" rel="noopener noreferrer">API documentation</a><a href="https://jwt.io/introduction" target="_blank" rel="noopener noreferrer">JSON WEB TOKENS (JWT)</a><h2>Still Need Help?&nbsp;</h2>Speak to our Customer Success team, who are here to support you via <a href="mailto:support@ankor.io">support@ankor.io</a> or chat with us using the Life ring Help feature at the bottom right of our application.

Back to Trips

Was this article helpful?

You recently requested to reset your password for your account. Use the button below to reset it. This password reset is only valid for the next 24 hours.

If you’re having trouble with the button above, copy and paste the URL below into your web browser.

Please check your email for instructions to reset your password.

Check your email

Enter your email address and we will send you instructions to reset your password.

Please enter a new password below.

Set your password