Documentation for Channex.io HTTP JSON-based API version 1.0
The Channex.io API is organised around REST. Our API has a predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application. JSON is returned by all API responses, including errors.
Each response is valid JSON object and MUST contain at least one key:
If response has success status, it MUST contain
metakey at response object.
dataobject CAN be an Object or Array of Objects.
attributeskeys with response object definition.
"message": "Human readability message"
"token": "Bearer Access Token",
PUTquery MUST contain a valid JSON Object and use
typeof passed object as key for data.
typeof passed entity.
Channex.io supports API Key access which can be created in the user profile section of the account that is subscribed to a active subscription.
Authentication method, where previously generated API Key is used to sign requests:
GET https://staging.channex.io/api/v1/properties/ HTTP/1.1
Channex uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicates success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, validation errors, etc.). Codes in the 5xx range indicates an error with the Channex servers and you should retry.
Each error response MUST include
errorsObject with error details.
"title": "Validation Error",
"can't be blank"
Errors Object MUST include
titlefields, other fields is optional.
200 OKSuccess Response
400 Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 UnauthorizedNo valid Bearer Token provided.
403 ForbiddenAccess forbidden. User does not have rights to call this action.
404 Not FoundThe requested resource doesn't exist.
422 Unprocessable EntityValidation Error.
Most List API endpoints at Channex by default returns only first 10 elements. To get more elements you should implement Pagination traversing logic. To work with pagination, use next arguments:
resourceis requested endpoint,
X- number of requested page,
Y- count of elements at response.
Please, keep in mind,
pagecounted from 1. Max
limitvalue is 100.
To control how much elements associated with current account, you can use
metasection from response:
The most List API Endpoints at Channex support order arguments to get the elements in order. Order field and direction should be provided as a GET argument:
fieldis a field name for sort,
directionhas two possible values (
Most endpoints by default sort entities by
titlefield at ascending direction.
Most API endpoints in Channex supports filtering data arguments. Our filtering API provide operations to comparison and inclusion checks.
Filtering arguments are passed as regular
GETarguments in the query string under the
filterprefix. Each field should be wrapped into square brackets:
filter[field]. To pass list of possible values, use comma symbol:
By default symbol
=mean comparison operator is equal if single value passed or is includes if list of values passed. But you can use other operators, like greater then or less then by passing it as second argument for filter:
filter[field][lte]=value. You can use more then one comparison operator for one field, to build conditions like DATE greater then 2019-01-01 and less then 2019-02-01.
- gt (greater than)
- gte (greater than or equal)
- lt (less than)
- lte (less than or equal)
- eq (equal to) default operation if you pass value after
- not (not equal to)
Field equal provided value.
Field should be equal to at least one values from provided list.
Pass several filter arguments.
Use greater then and less then comparison operations
For easy access to our API and to make some tests we have prepared a sandbox server that you can use to integrate. You can sign up yourself and create an API key in the user profile area of the admin.