Getting started
The Rest-API allows clients to request product level data by product ID or be searching the product name. All data is supplied in JSON format.
Create your API token
All API requests will need the bearer token supplied, follow the steps below to get your client specific token.
- To generate a token you will need to send a POST request to the following link:
api.rendered.ar/api/auth/login
- The body of your request should include the username (email) and the password you use to log in to the Rendered platform. It is suggested (but not required) to do this with the primary account holder details.
{
"username":"user@company.com",
"password":"yourpassword"
}- On POST we will confirm your login details, if successful you will receive your token. This token can be saved and included as authorization for all requests made for product specific data.
Tokens are valid forever, however from time to time these might reset and you will be required to create a new token.
Usage of the API
| Type | Request | URL | Key | Value |
|---|---|---|---|---|
| GET by ID | GET | api.rendered.ar/api/auth/products/$id | id | unique product id |
| Search | GET | api.rendered.ar/api/auth/products/search/$abc | key | string to search for |
Currently search looks in the name and description fields of a product. Multiple products can be returned.
Sample data output
If a specific ID cannot be found, or a search returns empty:
{
"status": "error",
"code": 0,
"message": "No product found, it either doesn't exist or you don't have permission to view it"
}Errors are likely due to one of two things. Either the product ID entered does not exist, or your account does not have access to that particular product id.
On success, the JSON object will be shown for the product specified:
{
"status": "success",
"code": 1,
"data": {
"id": 100,
"name": "Product Name or SKU/GTIN code",
"description": "This is the additional information when creating an order",
"status": 4,
"clientid": 1,
"project_created": "2022-02-21",
"date_finished": "2022-04-04 12:36:53",
"progress": 100,
"tblcustomfieldsvalues": [
{
"relid": 100,
"fieldid": 1,
"value": "RDP-000"
},
{
"relid": 100,
"fieldid": 6,
"value": "Master model"
},
{
"relid": 100,
"fieldid": 5,
"value": "https://client-##.rendered.ar/Product-Name.zip"
},
{
"relid": 100,
"fieldid": 3,
"value": "embed link goes here"
}
]
}
}Fields and Values
| Field | Value | Notes |
|---|---|---|
| id | 100 | Unique product id within Rendered. |
| name | Product name | The product name that was used to create the order, can be name, SKU or GTIN code. |
| description | Product description | The description of the product, this is the “additional info” from the order. |
| status | 4 | 1 = not started |
| clientid | 1 | Your client id, this is shared between all contacts for the client account. |
| project_created | 2022-03-08 | When the product was created. |
| date_finished | 2022-04-07 14:49:26 | The product was completed on this date and the final output URL shared. |
| progress | 100 | Percentage value of the progress of a product within the workflow. |
| customfieldsvalues.relid | 100 | This is the product id that these custom fields belongs to. |
| customfieldsvalues.fieldid | 1 | 1 = order id (is unique) 3 = embed link 5 = final download link 6 = product type (master, model variation or material variation) |
| customfieldsvalues.value | 1 = RDP-000 | Depends on the value of “fieldid”. Here you can get the final download link or embed link. |
To select a specific value from the customfieldsvalues array, use the object number:
data.tblcustomfieldsvalues[0].value
or (for the last one in the example, which would give you the embed link)
data.tblcustomfieldsvalues[3].value
