База знань LMS Collaborator

API - Список новин

• Для отримання списку новин створених на порталі потрібно надіслати GET запит на URI https://your-domain.davintoo.com/api/rest.php/news?action=get-all-public-news
• Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:

curl 'https://your-domain.davintoo.com/api/rest.php/news?action=get-all-public-news' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Відповідь

• В разі успішного запиту (HTTP код відповіді - 200), буде повернено результат виду:
  data - масив новин
  pager - об'єкт пагінації (інформація про кількість сторінок, поточну сторінку, кількість новин)

• В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку

API - Додавання новини

• Для створення новини потрібно надіслати POST запит на URI /api/v2/news/create
• У тілі запиту має бути JSON об'єкт з інформацією про новину.
• Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:

curl 'https://your-domain.davintoo.com/api/v2/news/create' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"public_at": "2022-07-20", "actual_to": "2022-07-25", "is_published": "true", "title":"How to choose an LMS for corporate training: criteria and tips", "body_text":"Implementing an LMS helps get rid of routine and automate many processes, such as standardizing training, onboarding, and certification. Choosing the right LMS is not an easy process, requiring time and a clear plan of goals and objectives.In this article we will tell you what to look for and what you need to consider when choosing a system for corporate training."}'

Формат об'єкта з інформації про новину

* Зірочкою відзначені обов'язкові поля

Відповідь

• У разі успішного запиту (HTTP код відповіді - 200), буде відповідь у форматі JSON з інформацією про створену новину:
  {"data":{"id":105,"title":"title","body_text":"body","is_published":true...}
• У разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку:
  {"title":{"required":"Field cannot be empty"}}