Сервис Qolio построен на основе клиент-серверной архитектуры и ничего не мешает получить доступ к информации вашего аккаунта через API.

API можно использовать для множества кейсов, таких как:

• Получение результатов проверок для операторов
• Автоматическая добавление и настройка пользователей

Главный API endpoint находится по адресу: https://api.prod1.dealapp.io.

Принцип Построения

API построен на основе спецификаций JSON API (https://jsonapi.org/). Вы можете подчеркнуть дополнительные знание по этому подходу в следующих статьях:

• https://habr.com/ru/company/oleg-bunin/blog/433322/
• https://www.youtube.com/watch?v=iwLhXmqROnw

Параметры GET запросов, которые могут приходится для получения информации:

Типы данных: в API используются простые типы данных - string, integer, float.

Авторизация

Авторизация происходит через JWT токены, которые можно получить по запросу на endpoint /auth/sign_in. На этот запрос вам прийдет ответ с установленными headers с названиями:

• uid
• access-token
• client

Установив эти три значения в свои последующие запросы, вы сможете использовать остальные запросы на API.

Тут вы можете увидеть пример работы с авторизацией с помощью утилиты curl:

curl -i -H "Content-Type: application/json" -X POST --data '{"email": "admin@dealapp.com", "password":"secret123"}' <https://api.prod1.dealapp.io/auth/sign_in> | grep -i 'client\\:\\|uid\\:\\|access-token\\:' > headers.txt
curl -X GET -H @headers.txt '<https://api.prod1.dealapp.io/api/v1/client_interactions?include=operator&page[number]=1>' | jq