Developer guide

The Autopilot developer guide shows you how to get started to interact with the Autopilot API, and provides use-case guidelines on how your own applications can interact with Autopilot to perform all possible interactions with the Autopilot API.

Getting started

Autopilot requires your application to interact with the Autopilot API using a custom API key. This key is required to authenticate every request made to the Autopilot API. Without this key, all requests are automatically rejected.

Each custom API key:

  • is unique and tied to a single Autopilot account (aka Autopilot instance),

  • does not require or involve any user authentication, but in itself, the key should be treated as a private key,

  • contains its own configurable default merge_by settings, when updating one or more people via the Autopilot API, and

  • which is configured as a data source, can be disconnected at any time through your Autopilot account’s user interface (UI), thereby preventing and rejecting any requests made to the Autopilot API until the custom API key is reconnected.

Therefore, create a separate custom API key for each application that will interact with your appropriate Autopilot account.

Tools

The code examples used throughout this Developer guide are presented as cURL commands, along with equivalent Node.js/JavaScript implementations.

You can work directly with the Autopilot API using the cURL command. Learn more about using cURL from the curl website and its documentation and man page reference guide.