Skip to end of metadata
Go to start of metadata

Формат запросов

Данные в запросах передаются методом POST по протоколу HTTP/1.1. Метод запроса также указан на странице с описанием каждого запроса. Параметры запроса помещаются в передаваемую структуру. Часть параметров может быть передана в URL (API key, format)

Формат входных данных указывается в HTTP-заголовке Content-Type.

Возможные значения заголовка:

  • application/json — формат JSON

  • application/xml - формат XML

Кодировка символов — UTF-8

POST https://example.com/api/v1.1/<имя метода>

Авторизация

Для авторизации необходимо в параметрах запроса передавать токен. Пример:

{
	"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"]
	}
}

Токен может быть создан в панели пользователя платформы, раздел "Настройки" - "Токены". Для создания токена необходимы права мастер-пользователя.

Токен генерируется автоматически после сохранения. Также в данном интерфейсе можно задать имя токена, и настроить права доступа (уточняются в роли) пользователей к данному токену, и группа, в рамках которой токену доступны объекты

Формат ответа

Формат ответа может передан в заголовке или в параметрах запроса.

Пример ответа (успешное выполнение операции):

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

В ответе возвращаются следующие параметры:

  • error - код ошибки
  • error_text - описание ошибки
  • profile_id - идентификатор профиля, к которому был применены действия согласно запросу. Получается при успешном выполнении операции.

Коды ответа

КодОписание
0Операция выполнена успешно
400Некорректный запрос
401Требуется API токен
402Достигнуто ограничение тарифа
403Нет прав на действие
404Обьект не найден в зоне видимости токена
409Существует другая запись с такими же признаками уникальности
413База данных недоступна в выбранном ресурсе
415Запрашиваемый Content-Type не поддерживается
435Неоднозначный поиск, есть несколько обьектов с заданными характеристиками
441Обьект принадлежит другой группе
450Ошибка валидации запроса
500Внутренняя ошибка сервиса
501Такой метод отсуствует

Дедупликация запросов

Если в момент получения данных произошёл сбой соединения, может быть отправлен повторный запрос. Платформа не будет воспринимать повторный запрос, если он приводит к изменению данных, чтобы исключить дублирование событий. Подробнее о повторных запросах читайте здесь.

  • No labels