Инструменты пользователя
apiv5_defs_api
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Следующая версия | Предыдущая версия | ||
|
apiv5_defs_api [2018/11/21 11:30] serg создано |
apiv5_defs_api [2019/10/15 08:39] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | [[apiv5|Назад]] | + | [[apiV5Client|Назад]] |
| ---- | ---- | ||
| + | |||
| + | Все API запросы и ответы базируются на следующих общих принципах: | ||
| == Запрос на сервер == | == Запрос на сервер == | ||
| - | Все API запросы базируются на следующих общих принципах: | + | * Все запросы на сервер типа **POST** http://yovourl/[METHODNAME]?id=[UserID]&token=[UserToken] |
| - | * Все запросы на сервер типа **POST** yovourl/[METHODNAME]?id=[//UserID//]&token=[//UserToken//] | + | * Остальные параметры запроса присылаются как POST PARAMETERS |
| == Ответ от сервера == | == Ответ от сервера == | ||
| - | |||
| * Сервера находятся за CLOUDFARE - если сервера недоступны **StatusCode ответа 50X** | * Сервера находятся за CLOUDFARE - если сервера недоступны **StatusCode ответа 50X** | ||
| * Если параметры id, token неверны - **StatusCode ответа 403 - HTTP Forbidden** | * Если параметры id, token неверны - **StatusCode ответа 403 - HTTP Forbidden** | ||
| * Если отсутствуют обязательные парамеры в POST запросе либо они не проходят проверку - **StatusCode ответа 412 - HTTP Status Precondition Failed** | * Если отсутствуют обязательные парамеры в POST запросе либо они не проходят проверку - **StatusCode ответа 412 - HTTP Status Precondition Failed** | ||
| * В удачно обработаного запроса сервером всегда **StatusCode ответа 200 - HTTP OK** | * В удачно обработаного запроса сервером всегда **StatusCode ответа 200 - HTTP OK** | ||
| - | * Удачный ответ от сервера всегда в JSON формате с обязательным полем "Error", которое пустая строка в случае отсутствия ошибок, либо строчный параметр с детализацией ошибки. Таким образом самый короткий удачный ответ от сервера вышлядит так {"Error":""} | + | * Удачный ответ от сервера всегда в JSON формате с обязательным полем "Error", которое либо пустая строка в случае отсутствия ошибок, либо строчный параметр с детализацией ошибки. Таким образом самый короткий удачный ответ от сервера выглядит так ''{"Error":""}'' |
apiv5_defs_api.1542799808.txt.gz · Последние изменения: 2019/10/15 08:47 (внешнее изменение)
Инструменты страницы
