Update README.md

parent e286d11c
......@@ -39,3 +39,63 @@
{ "name": "test name", "file_ids": [1,2], "sub": { "name": "foo", "message": "bar" }, "flag": true }
```
### <a name="auth">Аутентификация</a>
API аутентификация реализована по протоколу OAuth2. Рекоммендуется использовать HTTP Authorization. Также реализована поддержка отправки токена в строке запроса или через POST параметры.
OAuth2 токен в header:
```text
curl -H "Authorization: Bearer <ACCESS-TOKEN>" "https://demo.mgik.rnds.pro/api/v1/courses"
```
OAuth2 токен в строке запроса:
```text
curl "https://demo.mgik.rnds.pro/api/v1/courses?access_token=<ACCESS-TOKEN>"
```
### <a name="SSL">SSL</a>
При попытке вызова API запроса через протокол http будет выполнена переадресация на https
0
### <a name="OAuth2">OAuth2</a>
OAuth2 - протокол, разработанный для того, чтобы сторонние приложения могли авторизоваться для выполнения операций, как обычный пользователь в целевой системе, без ипользования пользовательского пароля.
### <a name="Methods_intro">Методы API. Введение</a>
- API Endpoint атрибуты
Система добавляет атрибуты к ссылкам в возвращаемых html сниппетах для того, чтобы пользователям API было проще их обработать.
Атрибуты:
- data-api-endpoint - URL-адрес для доступа к объекту where the linked object can be accessed via the API
- data-api-returntype - Тип возвращаемых данных
Например, рассмотрим описание, содержащее ссылку на вики страницу в курсе. Описание, возвращаемое GET методом будет выглядет следующим образом:
```text
<a href="https://demo.mgik.rnds.pro/courses/123/pages/a-wiki-page"
data-api-endpoint="https://demo.mgik.rnds.pro/api/v1/courses/123/pages/a-wiki-page"
data-api-returntype="Page">Дополнительная информация</a>
```
Поддерживаемые значения data-api-returntype:
- Assignment
- Discussion
- Page
- File
- Folder
- Module
- SessionlessLaunchUrl
### <a name="Methods">Методы API. Список</a>
| Метод | описание
| ----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------
| API Token Scopes | (#method.scopes_api.index)[Список скоупов доступных через ключи разработчика и токены] |
| Account Domain Lookups | (#method.account_domain_lookups.search)[Частичное совпадение по поддерживаемым именам/доменам] |
| Account Notifications | (#method.account_notifications.user_index)[Индекс объявлений] (#method.account_notifications.show)[показать объявление] ( #method.account_notifications.user_close_notification)[закрыть объявление пользователю] (#method.account_notifications.create)[создать глобальное объявление] (#method.account_notifications.update)[обновить глобальное объявление]
| Account Reports | (#method.account_reports.available_reports)[Показать список доступных отчетов] (#method.account_reports.create)[Начать отчет] (
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment