Взаимодействие с API
Формат запросов
Данные в запросах передаются методом POST по протоколу HTTP/1.1. Метод запроса также указан на странице с описанием каждого запроса. Параметры запроса помещаются в передаваемую структуру. Часть парамет ров может быть передана в URL (API key, format).
Формат входных данных указывается в HTTP-заголовке Content-Type.
Возможные значения заголовка:
- application/json — формат JSON
Кодировка символов — UTF-8
POST https://example.com/api/v1.1/<имя метода>
Если вы работаете в облачном аккаунте Altcraft Platform, используйте URL-адрес панели управления: ru.altkraft.com
. При установке платформы на ваше оборудование (on-Premise) — используйте ваш собственный URL.
Описание ф ормата JSON вы найдёте в RFC 8259: https://www.rfc-editor.org/rfc/rfc8259.
Не забывайте кодировать символы, которые не могут быть непосредственно записаны в JSON.
Авторизация
Для авторизации необходимо в параметрах запроса передавать токен. Пример:
{
"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"]
}
}
Токен может быть создан в панели пользователя платформы, раздел "Настройки" — "Токены". Для создания токена необходимы права мастер-пользователя.
Токен генерируется автоматически после сохранения. Также в данном интерфейсе можно задать имя токена, и настроить права доступа (уточняются в роли) пользователей к данному токену, и группу, в рамках которой токену доступны объекты.