This article summarizes all information about Peero API - authentication, rate limits, and requests.

Peero API needs to be enabled by Peero Team. How to enable Peero API?

In this article, you will learn about:

1. Authentication
2. Rate limits
3. Requests
   1. Token for user authorization
   2. User creation
   3. User import
   4. User update
   5. User deletion
   6. Error messages

1. Authentication

Authentication occurs using the Group ID and the Secret Key obtained after the creation of the application.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

2. Rate limits

Access to all endpoints is limited to 6 requests per second. This limit is applied per API token and per IP address. If you exceed the limit, a 429 HTTP status code will be returned with the body in JSON format:

{
   "success": false,
   "message": "Too many requests."
}

3. Requests

3.1. Token for user authorization

/ext/user/auth

After receiving the authToken, you can repass the get parameter auth_token=<authToken> for automatic user authorization (token lifetime - 60s)