Rendered API tokens
Rendered API tokens are used to authenticate requests to the API. When calling a Rendered API endpoint, you need to supply a valid API token in the HTTP Authorization header, with a valid token specified as the header value. For example:
Auth: Bearer 00QCjAl4MlV-WPXM…0HmjFx-vbGua
Create the token
The POST login API is used to retrieve the authentication token. The email and password you use to login to the Rendered account should be used in the request. After the authentication token is obtained, it must be inserted into the Auth token header for all requests.
POST https://api.rendered.ar/login HTTP/1.1
Host: api.rendered.ar
Content-Type: application/json
{
"email":"example@domain.com",
"password":"yourpassword"
}
On a successful request, you will receive your token:
HTTP/1.1 200 OK
{
"status": true,
"message": "Login successful",
"user_id": "1",
"token": "00QCjAl4MlV-WPXM...0HmjFx-vbGua",
"expiry_date": "2024-11-01 13:35:25"
}
This token can now be used for all other GET and POST endpoints in the Rendered API. This token should be supplied as an Auth header, including the Bearer identifier. For example:
GET https://api.rendered.ar/search_product/Sample HTTP/1.1
Host: api.rendered.ar
Auth: Bearer 00QCjAl4MlV-WPXM...0HmjFx-vbGua
Testing the token
The POST checktoken endpoint can be used to test the token.
POST https://api.rendered.ar/checktoken HTTP/1.1
Host: api.rendered.ar
Auth: Bearer 00QCjAl4MlV-WPXM...0HmjFx-vbGua
On a successful request, you will get confirmation that your token is valid.
HTTP/1.1 200 OK
{
"status": true,
"message": "Authenticated API response",
"user_id": "1"
}
Token specifics
Login
Every time you use the login endpoint, a new token will be generated and you will be required to use this new token for all other API endpoint calls.
Expiration
Token are valid for 365 days. After this time your token will expire and you will be required to login again to receive a new token. It is recommended to periodically refresh your token, simply use the Login endpoint to generate a new one.
user_id
Both the login and the checktoken endpoints also return the user_id. This is used for all other endpoint calls to link the products and data from your Rendered account.
