API

Введение

Внимание!

API находится в режиме альфа-тестирования.

Если вы обнаружили ошибку в работе API, напишите нам о ней на [email protected]

Доступ к API

Доступ к API осуществляется по многоразовому токену аутентификации.

Токен выдается по запросу в техническую поддержку через личный кабинет, или по email: [email protected].

Точка доступа

Доступ к API осуществляется по URL:

https://{subdomain}.inskill.ru/api/v3/

где {subdomain} - уникальный поддомен вашего проекта в системе InSkill.

Доступ к API по HTTP-протоколу не поддерживается.

Используйте только HTTPS-соединение.

Формат данных

Все данные передаются в формате JSON в теле запроса.

Ответы на запросы также возвращаются в формате JSON.

Каждый запрос должен содержать заголовки формата:

Accept: application/json
Content-Type: application/json

Подробнее о формате: https://jsonapi.org/format/

Ограничения

Количество запросов к API ограничено: не более 200 запросов в минуту.

При превышении лимита возвращается HTTP-статус 429 (Too Many Requests), а в заголовке ответа присутствует параметр Retry-After – количество секунд до сброса лимита.

Аутентификация

Каждый запрос должен содержать Authorization заголовок с токеном аутентификации.

Аутентификация происходит по Bearer методу.

Токен указывается через пробел после команды Bearer.

Примеры

HTTP

POST https://fitnessproject.inskill.ru/api/v3/students
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjA2YmVlYWQ5MzE3MjI3ZmFjMDg1MDc3YmZiOGIxZTY0YmFlNzUwYTc2MWQ5ZjRmYjk5YWQ4YTRmZWUxN2Q5NTcwYWZiNDI5N2FjODE4MzgyIn0.eyJhdWQiOiIxIiwianRpIjoiMDZiZWVhZDkzMTcyMjdmYWMwODUwNzdiZmI4YjFlNjRiYWU3NTBhNzYxZDlmNGZiOTlhZDhhNGZlZTE3ZDk1NzBhZmI0Mjk3YWM4MTgzODIiLCJpYXQiOjE1NDkwMTE3NzYsIm5iZiI6MTU0OTAxMTc3NiwiZXhwIjoxNTgwNTQ3Nzc2LCJzdWIiOiIzIiwic2NvcGVzIjpbXX0.QVPVkH_X40mMfsTNziWAEVp8Ch7cvKVVEJsxCZ2NuvI5-TIz4ZLDCZlcwjkf2i7N2ZyzYG42dF1OxbcCUofsJbh1MEUkM_1kYs9TbGgnfsdb4QJr4MvFHwP4g-SfmbDCg0_cFxsZmvVbeqLuEXGuefqokpNjrCRHC42FkFDYvrgXpVJwDgCEX9Ohh2A1stL84hhJ8ybThU6SGWTuvisOewN41ufoEt3FV6ig-GoBCychmaETMMvtl_Ag3_qalbNQqRU1m0R36u8H6G96ba7HKF15fvkWS0zAelhSihUm-q7IuLPOITD7ybmW_C1idrZFDseQ3Oj5v05rE_uxsNKP2wKX-ECtmHSWddTTy4k-f4-5uHxSNx6eMPcJVSM4HeSCKOcJrgr-vqpTlju4m5yRoIbiYUbcKL4dpQZBPDLszZn7MLiO05yC6P00NzmoZSYJ8ENRBXnZZLQ3f5pQKfeyma8WA2d9TP26hHnW9dGzmpNJnf-VLRPq6LRLV63dFpBPaUgOvRcxuokCeHgMeDaRCZOKcUtH9UYy15yhYbvoh3Cbkl7-itCROMVYYxhjL7MdzXcH06QsNqyA_GVgiPtFV0Q7CGg9QXRrU1pNNQMQfrSNpvdOP5E48UuYqroBHaxn5lLO1HuvC3VzcvRy0-0IntHb92zcFD5zE-OhipCpYQ8

PHP

Если вы используете Guzzle для запросов (http://docs.guzzlephp.org/en/stable/) - просто добавьте соответствующие заголовки в настройки клиента:

$client = new Guzzle( [
'base_uri' => 'https://fitnessproject.inskill.ru/api/v3',
'headers' => [
'Authorization' => 'Bearer ' . $token,
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
] );

Список ресурсов

Students

Управление участниками проекта.

API находится в режиме разработки.

Список ресурсов будет пополняться.