API – Імпорт зовнішнього рейтингу
Для авторизації використовуйте АРІ token. Детально в статті API token
Імпорт для одного користувача
- Для імпорту зовнішнього рейтингу потрібно надіслати запит POST на URI /api/v2/users/external-rating/set-rating
- У тілі запиту повинен бути JSON об'єкт з інформацією про користувача, дату та значення рейтингу.
- Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.
Приклад запиту:
curl 'https://your-domain.davintoo.com/api/v2/users/external-rating/set-rating' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"user_id":6085,"rating":94,"date":"2022-07-17"}'
Замість локальної адреси https://your-domain.davintoo.com потрібно використовувати адресу вашого інстансу.
Для того, щоб зовнішній рейтинг відображався на графіку в історії навчання користувача (детальніше Перегляд рейтингу користувачем) в налаштуваннях порталу має бути включена опція Дозволити додавати зовнішні дані на графік рейтингу користувачів. Дану опцію вмикає технічна підтримка порталу.
Формат об'єкта з інформацією про користувача
* Зірочкою відзначені обов'язкові поля
Для ідентифікації користувача повинні бути вказані user_id або uid
| Поле | Тип | Опис |
|---|---|---|
| user_id | Число | Внутрішній ідентифікатор користувача у системі |
| uid | Рядок | Зовнішній ідентифікатор користувача у системі |
| rating | Число | Значення зовнішнього рейтингу (одинарна метрика) |
| complex_rating | Object | Значення зовнішнього рейтингу (декілька метрик, об'єкт в форматі "меттрика":"значення") |
| date* | Рядок | Дата, у форматі РРРР-ММ-ДД |
Відповідь
- В разі успішного запиту (HTTP код відповіді - 200), повертає JSON об'єкт з інформацією про оновлення
- В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку:
{"user_id":{"required":"Field cannot be empty"}}
Пакетний імпорт
- Для імпорту зовнішнього рейтингу декількох користувачів потрібно надіслати запит POST на URI /api/v2/users/external-rating/set-ratings-multi
- У тілі запиту повинен бути масив JSON об'єктів з інформацією про користувача, дату та значення рейтингу.
- Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.
Приклад запиту:
curl 'https://your-domain.davintoo.com/api/v2/users/external-rating/set-ratings-multi' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '[{"uid":"ux-123456","complex_rating":{"metric1":10,"metric2":20},"date":"2022-07-17"}]'