Read one documentation entry
Read one guide or endpoint contract, including examples.
/v1/integrations/{id}- Access
- Public; API key optional
- Client
- Browser fetch supported
Parameters#
| Name | Location | Meaning |
|---|---|---|
idRequired | Path | Documentation entry ID from the catalogue. |
lang | Query | en or it. English is the default. |
Request examples#
curl -fsS 'https://veil.rip/v1/integrations/lookup'const response = await fetch("https://veil.rip/v1/integrations/lookup");
const result = await response.json();Try the request#
Response#
The entry’s localised description, parameters, response notes and example blocks, with the catalogue revision.
| Field | Type | Meaning |
|---|---|---|
revision | string | Catalogue revision. |
language | string | en or it. |
entry | object | Full localised reference. Endpoints include responses, responseObjects, responseHeaders, errorDetails and the existing request parameters and examples. |
Not modified. Reuse the representation stored with this ETag; there is no response body.
Response headers#
| Header | Value | Meaning |
|---|---|---|
Content-Type | application/json | Use the declared media type before choosing a parser. |
Date | HTTP date | Server time. Compare it with your clock when signing requests. |
ETag | opaque validator | Send back in If-None-Match. A matching revision and language returns 304 with no body. |
Cache-Control | public, max-age=300 | The reference can be cached for five minutes. |
Retry-After | integer seconds, on rate_limited or busy | Wait at least this long before retrying. Other 429/503 codes do not necessarily include it. |
Errors#
API errors return an error object. Use error.code for program logic; error.message is English text for people and can change. Response and error guide
| HTTP | Code | Meaning and next step |
|---|---|---|
| 400 | invalid_parameter | A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in |
| 404 | not_found | The requested card, key, alias, code or resource was not found. Check the identifier. Temporary codes and previews may already have expired or been used. |
When using an optional API key
| HTTP | Code | Meaning and next step |
|---|---|---|
| 401 | invalid_api_key | The bearer credential is malformed, unknown, expired or revoked. Use an active key. To use anonymous public access, remove |
| 403 | api_key_scope | The API key lacks read or verify scope, or the endpoint does not accept bearer keys. Use the correct scope. Identity writes and key management still require a device signature. |
| 403 | api_key_suspended | This API key is suspended. Ask staff to restore it; another key cannot lift an account suspension. |
| 403 | developer_suspended | The owner’s API account is suspended or the owner card is unavailable. Check the owner account and any staff restriction. Creating another key does not bypass suspension. |
Shared request errors
| HTTP | Code | Meaning and next step |
|---|---|---|
| 429 | rate_limited | An anonymous, signed-request or API-key allowance was exceeded. Wait at least |
| 500 | internal_error | An unexpected server error occurred. Internal details are not returned. Retry reads with bounded backoff. Check write results before sending a new signed operation. |
| 503 | busy | The application has reached a temporary concurrency or database limit. Wait |