API Overview

Introduction

The Ariel APIs enable partners and vendors to integrate with the Ariel Assignment of Rights (AOR) application. This documentation provides an overview of available API endpoints and how to use them.

API Capabilities Overview

This API provides the ability to:

• Create and manage characters, contacts, and contracts.

• Search and retrieve information related to characters, contacts, controlled vocabulary, and users.

• Upload and void contracts, update territory on orders, claim orders, and complete orders.

Authentication Base URLs

You need to obtain an access token to make requests to the Ariel API.

Both Stage and Production environments use the same authentication base URL:

API Base URLs

There are different Base URLs per environment.

Error Handling

The Ariel APIs follow standard HTTP status codes to indicate the success or failure of an API request.

Here are some common status codes you may encounter:

• 200 OK: The request was successful, and the response contains the requested data.

• 201 Created: The request was successful, and a new resource was created.

• 204 No Content: The request was successful, but there is no content to return.

• 400 Bad Request: The request was invalid or cannot be otherwise served.

• 401 Unauthorized: Authentication failed or user does not have permissions for the requested operation.

• 403 Forbidden: The server understood the request, but it refuses to authorize it.

• 404 Not Found: The requested resource could not be found.

• 409 Conflict: The request could not be completed due to a conflict with the current state of the target resource.

• 429 Too Many Requests: Too many requests were sent in a given amount of time.

• 500 Internal Server Error: An error occurred on the server while processing the request.