> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/technical-guide/api-fundamentals/overview.md).

# Overview

API Integration involves using [**RESTful APIs**](https://apidocs.openloyalty.io/) to establish direct communication between your systems and Open Loyalty.\
[**Our API**](https://apidocs.openloyalty.io/) use standard HTTP methods (GET, POST, PUT, DELETE) and JSON data format for request and response payloads.

To ensure secure communication, you need to authenticate requests using mechanisms such as API keys or OAuth 2.0 tokens.

* [**API Keys**](https://help.openloyalty.io/settings#permanent-user-token)**:** Unique identifiers that authenticate requests on behalf of a specific user or application. They should be kept secure and never exposed in a client-side code.
* [**OAuth 2.0**](https://apidocs.openloyalty.io/#section/Authentication)**:** An industry-standard protocol for authorization, enabling third-party applications to obtain limited access to a user's resources without exposing their credentials.\
  OAuth 2.0 uses access tokens and refresh tokens for secure and controlled access to resources.

### Integration and management APIs

The [Fair Usage Policy](https://www.openloyalty.io/fair-usage-policy) groups the API into two types by purpose, with different performance expectations:

|                 | Integration APIs                                   | Management APIs                                                                           |
| --------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Purpose**     | Near real-time data syncing and content display    | Administrative functions, such as loyalty programme management and back-office operations |
| **Performance** | Built for high performance and fast response times | Not designed for high concurrency or near real-time use                                   |
| **Throughput**  | Up to 1,500 concurrent API calls on production     | No guaranteed number of concurrent calls                                                  |

Management APIs can be used in integrations, but use them in lower-traffic scenarios where real-time performance isn't essential.

Open Loyalty may update which APIs fall into each type. Changes are published in the [API documentation](https://apidocs.openloyalty.io/).

For throughput and rate limits per environment, see [Environments Capabilities](/technical-guide/api-fundamentals/environments-capabilities.md) and [Limits](/technical-guide/api-fundamentals/limits.md).

#### Learn more about:

{% content-ref url="/pages/Y8J4CNW7mlrRCe2qv04F" %}
[Admin Token](/technical-guide/authentication/admin-token.md)
{% endcontent-ref %}

{% content-ref url="/pages/SUKudcdLi1dqeYkqI9LD" %}
[Access Token (API Key)](/technical-guide/authentication/access-token-api-key.md)
{% endcontent-ref %}

{% content-ref url="/pages/DFlgjquvIq6d14Xi4ojl" %}
[Enabling SSO Login via Auth0](/technical-guide/authentication/enabling-sso-login-via-auth0.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.openloyalty.io/technical-guide/api-fundamentals/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.