Requests format

Requests are sent by POST method using HTTP/1.1 protocol. The method is also mentioned on each request description page.

Request parameters are placed in the sent structure. Some parameters can be sent in URL (API key, format).

The input data format must be indicated in the Content-Type HTTP header.

Possible header values:

• application/json — JSON format

Symbols must have UTF-8 coding.

POST https://example.com/api/v1.1/<method name>

If you use an Altcraft Platform cloud account, send API requests to the URL ru.altkraft.com. In the case of deploying the platform on your hardware (on-Premise), use your own URL.

A description of the JSON format can be found in RFC 7159: http://tools.ietf.org/html/rfc7159.

Don't forget to encode characters that cannot be directly written in JSON.

Authorization

API token must be sent in request parameters for authorization. Example:

{
	"token": "bfc505684d774e52b188fa1f003cd5ed",
	"db_id": 1,
	"resource_id": 1,
	"matching": "email",
	"email": "example@example.com",
	"data": {
		"_status": 0,
		"_fname": "Jim",
		"_lname": "Jones",
		"email": "example@example.com",
		"phones": ["+79000000000"]
	}
}

API token can be created in the user panel, in section "Settings" - "Tokens". Master user rights are necessary to create a token.

API token is automatically generated after saving. You can also select a token name and configure access rights (in roles) and groups of objects available for this token.

Response format

The response format can be selected in the request header or parameters.

Response example (Successful operation):

{
	"error": 0,
	"error_text": "Successful operation",
	"profile_id": "5f4fa1a5ce9448665fef548e"
}

The following parameters are given in responses:

• error - error code
• error_text - error description
• profile_id - profile identifier (for successful operation)

Response codes

Request deduplication

If the connection fails at the moment of receiving the data, a second request may be sent. The platform will not accept a repeated request if it modifies the data in order to avoid duplicate events. Read more about repeated requests here.