.png?sv=2022-11-02&spr=https&st=2024-12-22T11%3A48%3A09Z&se=2024-12-22T11%3A58%3A09Z&sr=c&sp=r&sig=FMmz4D3PPrmqfqwHT2DCxwHiQqzEooXLWY9WruO2FK0%3D){kind=logo}
Overview
- 19 Jan 2024
- 1 Minute to read
- Print
- PDF
Overview
- Updated on 19 Jan 2024
- 1 Minute to read
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
API guide
This API guide is your go-to resource for understanding how to use the API. It provides you with in-depth documentation and direct access to the API reference so that you can execute requests that meet your company's unique needs.
Within the guide, you will find coverage of these sections:
API Foundations: Gain or refresh your fundamental knowledge of RESTful APIs.
Quick Start: Collect the necessary information to access and generate requests using endpoints in the API reference.
Authentication & Authorization: View step-by-step authentication and authorization instructions so that you can access the API.
Create a Request: Learn how to make calls using the interactive console in the API guide or the Swagger UI.
OData Syntax and Query Parameters: Better understand the application of OData syntax when constructing queries so you can execute successful requests.
Status Codes: A comprehensive list defining the HTTP status codes encountered after request submission.
Throttling: A list of endpoints with throttling limitations.
FAQs: Frequently asked questions.
Glossary: Terminology specific to the API.
What's New?: View the latest release notes.
API Reference: Rendering of the API definition. Includes the same publicly available endpoints accessed from the Swagger UI tool. The reference is categorized by API resources and subcategorized by endpoints. After generating an access token using the steps outlined in the Authentication & Authorization section, you can use this guide 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.
Note: This guide only provides information about the RESTful API.
Was this article helpful?