Публичный API Автошкола-контроль
- Все запросы к API выполняются по базовому URL https://app.dscontrol.ru/
- В заголовках запроса (Headers) необходимо указывать:
| Header | Значение |
|---|---|
| X-Requested-With | XMLHttpRequest |
| Content-Type | application/json |
| api_key | Ключ API сотрудника |
- К API не может быть выполнено более 3 запросов в секунду с одним ключом API
При превышении нагрузки на API, при массовых запросах к API, носящих признаки «спама», учетная запись школы может быть полностью заблокирована для всех сотрудников и учеников до выяснения и устранения причин аномальной нагрузки.
- Сервис отвечает с соблюдением общепринятых HTTP-кодов ответа:
| HTTP Code | Статус выполнения запроса |
|---|---|
| 200 | Запрос успешно обработан |
| 401 | Ошибка авторизации – неверный api_key |
| 500 | Ошибка обработки запроса |
При успешном запросе в теле ответа будет содержаться ответ сервиса в формате JSON в объекте следующего вида:
{
"success": true,
"data": {…} или [] // данные в виде объекта или массива
}
Запрос с ошибкой обработки:
{
"success": true,
"data": {
"Message": 'текст ошибки'
}
}
- Все запросы на получение данных выполняются методом GET, на изменение данных – методом POST.
- В запросах на изменение данных (POST) в теле запроса ожидается объект в формате JSON.
