Zluri External APIs v1
Documentation
Authorization
API Keys can be used to authenticate the use of Zluri Web API v1 endpoint. API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access.
Requests
Host
| Base Url | https://api-ext.zluri.com |
|---|
All requests must be made over HTTPS. The API does not support HTTP.
Authorization Header
You must provide an authorization header as described in authentication.
HTTP Verbs
| Verb | Description |
|---|---|
| GET | Retrieve a resource or group of resources |
| POST | Create a new resource |
| PUT | Update an existing resource |
| DELETE | Delete an existing resource |
| OPTIONS | View allowed verbs against a specific resource |
Formatting Your Request
Request Body
When submitting data to a resource via POST or PUT, you must submit your payload in JSON.
Responses
Content-Type Header
All responses are returned in JSON format. We specify this by sending the Content-Type header.
Errors
Sometimes API call will generate an error. Here you will find additional information about what to expect if you don't format your request properly, or we fail to properly process your request.
Response Codes
| Status Code | Description |
|---|---|
| 400 | Bad request |
| 401 | Requires authentication |
| 429 | Too many requests/Rate limit exceeded |
| 500 | Internal server error |
Authentication
- API Key: apiKey
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | api-key |