Links
Follow the links in a response instead of building URLs.
Every successful response has a links array. Each link points from the resource in the response to a related one:
{
"account": {
"id": 123,
"name": "Jane Doe"
},
"links": [
{
"rel": "self",
"href": "https://api.redokun.com/v1/me"
}
]
}| Field | Description |
|---|---|
rel | How the target relates to the resource that holds the link |
href | Absolute URL of the target, always https |
Follow the href as it is, instead of building the URL yourself: a change of path then does not break your integration.
Relations
rel | Target |
|---|---|
self | The resource in the response |
Reading links
- Find a link by its
rel, not by its position in the array. - Ignore any
relyou do not know. New relations can appear without notice.