Authentication

The PeopleOS API uses API keys to authenticate requests. You can view and manage your API keys in your administration panel.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

On our instance, all API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. On your instance, it will be up to you.

You must use the API key in the Authorization header. The value must be Bearer followed by a space and then the API key.

On our instance, the API calls are rate limited to 60 requests per minute. On your instance, you can change that settings in the api.php configuration file.