What you need to know to start using the Inspire API
What does the Inspire API do?
You can use the Inspire API to integrate with the Inspire Payment Platform for processing payments for products and subscriptions.
Authentication
The Inspire API uses Bearer authentication.
You must pass two header parameters for authentication:
- A valid JWT token in the
bearerheader. - Your Inspire instance identifier in the
tenantheader.
To get your JWT token, you need to make a request to the /auth/sign-in endpoint using your Inspire instance identifier, the email address associated with your account, and your password. For more information, read Authenticate a tenant.
Pagination
When an endpoint returns a list of objects, pagination allows you to partition the dataset instead of accessing all the records at once.
Endpoints that implement pagination have the following optional query parameters:
| Name | Type | Description |
|---|---|---|
isPaginated | Boolean | When False, pagination is not used in the response. True by default. |
page | Integer | Page to return. Page numbering starts with 0. |
pagesize | Integer | The number of documents per page. Determines the maximum size of each page. |
sortby | String | Controls the sorting direction and the name of the sort-by field. Format: <field_name>.<asc|desc> (asc for ascending order, desc for descending order). |
Note that some endpoints use theisPaginatedparameter to allow you to turn pagination off. This parameter is True by default.