Rotageek has public APIs for your organisation to pull data that is needed. This article explains how to use our public API links.
What do you need?
To be able to access Rotageek's public API, you will need an Admin account for Rotageek for your organisation. If you do not have this, please reach out to your Customer Success Manager who can set one up for you.
To view what data can be obtained, select the correct link below based on your organisation:
Authentication:
To authenticate with the API, you must obtain an access token by sending a POST request to the authentication endpoint at /api/v1/auth. Depending on your use case, you will include different form parameters.
Initial Authentication:
Set
grant_typetopasswordProvide your
usernameandpasswordin the form data
Token Refresh:
Set
grant_typetorefresh_tokenProvide your current
refresh_tokenin the form data
The API responds with a JSON payload containing an access_token, a refresh_token, and an expires_in value that indicates how long the access token is valid. For each API call that requires authentication, include the token in your HTTP header like so:
Authorization: Bearer <access_token>
Token Refresh Explained:
When your access token nears expiration, you don’t need to ask the user for their credentials again. Instead, you can refresh the token using the refresh token provided during the initial authentication:
How to Refresh:
Make another POST request to
/api/v1/authUse
grant_typeset torefresh_tokenalong with therefresh_tokenyou received earlier
What Happens:
The server validates your refresh token and returns a new access token (and possibly a new refresh token)
This process allows your application to maintain an active session without interrupting the user experience
This seamless token refresh mechanism ensures that your API integration remains secure and efficient while minimizing the need for repeated user logins.
How to use the Public API: