Introduction

Getting Started with Your API Project

Ready to initiate your API project? Here's a guide to get you started:

• Step 1: Connect with Your Avinode Group Contact

  Begin by reaching out to your dedicated Avinode Group Contact. They will serve as your main guide, offering tailored insights and assistance specific to your project. If you don't have a contact or aren't a current member, initiate the application process for Avinode here or for Schedaero here.

• Step 2: Collaborate to Define Your Use Case

  Once contact is established, we'll work closely together to define your use case. If your API solution differs from the standard use cases (read more about these in the "Working with Our APIs" section below), we're eager to discuss your unique business cases and offer insights for a successful application.

• Step 3: Obtain Sandbox Access

  Once your use case has been defined, you will get access to the sandbox environment, as long as you are either an Avinode/Schedaero member or have a launch customer who is already a member.

Before you start developing...

Explore the information on the following pages to familiarize yourself with our APIs and the process:

• Avinode Group API Basics
• Sandbox Environment
• Terminology

We look forward to collaborating with you and making your API project a success!

Working with Our APIs

Our most common API use cases are found here:

• Avinode Workflow Use Cases
• Avinode End Client Facing Use Cases
• Schedaero Use Cases Overview

If your API solution will do something different than what is described in any of the example use cases, then you should ensure that your use cases have been approved by Avinode or Schedaero before you start building your application. You should also ensure that all use cases that your application will implement are included in your API subscription.

We are more than happy to discuss the different business cases that your application will handle and offer any insights we might have in relation to these.

Implementation

You will have access to the Sandbox environment to use this during development and testing. Before finishing implementation, you should verify that your API solution conforms to all items on the implementation check lists that are applicable to your use case. These check lists are available under each use case in this documentation.

Going Live

When you are ready, we will do a review to ensure that your API solution works in the best possible way before it will be allowed to access our live environment.

🏁