API

Введение

Внимание!

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

Если вы обнаружили ошибку в работе API, напишите нам о ней на api@inskill.ru.

Доступ к API

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

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

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

Доступ к 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 [TOKEN]

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

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

pageStudents

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

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

Last updated