Overview

API guide

 Reference this guide to understand how to use the API. It provides in-depth documentation and access to the API reference so you can execute requests to meet your company's unique needs.  

Create a Request: Learn how to make calls using the interactive console in the API guide or the Swagger UI. 

Throttling: A list of endpoints with throttling limitations. 

FAQs: Frequently asked questions.

Glossary: Terminology specific to the API. 

What's New?: View the release notes. 

API Reference: Rendering of the API definition. Includes the same publicly available endpoints accessed using the Swagger UI tool. The reference is categorized by API resources and uncategorized by endpoints. After generating an access token using the steps outlined in the Authentication & Authorization section, you can use the reference to construct and test calls the same way you would using the Swagger UI. 

Aspire External API essentials 

The external Aspire API contains the following criteria:

• RESTful architectural design using OData version 4.   
  • Responses in JSON data format. 
• Securely transmits data via HTTPS . 
• Uses the following HTTP methods: 
  • GET - retrieve information. 
  • POST - create or add new information. 
  • PUT - update existing records. 
  • DELETE - remove a record. This method does not currently apply to any External Aspire API reference resources.
  • GET, PUT, and DELETE are idempotent
• Bearer Authentication security. 
• Offers endpoint-level access for users. 
• The API reference is also available via the Swagger UI. 
  This guide only provides information about the RESTful API.