Getting started with Afi Platform API

The Afi API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Requests to the Afi API are authenticated with the Application API keys. Application is a key concept for building integrations with Afi and provides API access to the resources and configuration in tenants where the Application is installed. All the modification operations leave audit records with an Application name as an actor.

The Afi API is versioned with breaking changes resulting in a new API version, while minor changes and new functionality are released without API version change. These docs are customized to the API version selected in the toolbar.