Conventions
Response format
Data is returned as JSON.
Naming
Resource names
- Always plural:
videos, notvideo. JSON
- Keys are
camelCase.
Plural resource names
/videos
/videos/{id}Camel case property names
{
"songTitle": "R-Type"
}
Identifiers
Resources have two unique identifiers.
ID
- A unique 36–character string of letters, numbers and hypens assigned to each resource object as its canonical ID.
Reference
- A hashed version of the ID. This is provided as a human-friendly identifier and should not be considered persistent.
Who am I?
{
"id": "177b7bce-6a42-4c20-9316-23ca426ba648",
"reference": "TV10868296"
}