types | Описание | Параметры в запросе |
---|---|---|
В одном запросе возможно отправить только 1 тип | ||
balance | Проверка баланса
• Текущий баланс
|
Обазятельные token - персональный ключ API |
performance | Проверка работоспособности API
• Работоспособность API
• Работоспособность метода API
|
Обазятельные api - название api method - метод api (type) token - персональный ключ API |
stlastday | Статистика расходов за предыдущий день |
Обазятельные token - персональный ключ API |
stlastweek | Статистика расходов за неделю |
Обазятельные token - персональный ключ API |
stlastmonth | Статистика расходов за месяц |
Обазятельные token - персональный ключ API |
https://api-cloud.ru/api/apilk.php?type=balance&token=53ba1b7a55abbB014aa97eff3a522079
{ "status":200, // Статус запроса "balance":205.39999270439, // Текущий баланс, без округлений }
https://api-cloud.ru/api/apilk.php?type=performance&api=fssp&method=physical&token=53ba1b7a55abbB014aa97eff3a522079
{ "status":200, // Статус ответа "api":"fssp", // API "method":"physical", // Метод (type) "performance":true // Статус работы (true - работает / false - не работает) }
https://api-cloud.ru/api/apilk.php?type=stlastday&token=53ba1b7a55abbB014aa97eff3a522079
{ "status": 200, // Статус ответа "date_st": "18.06.2024", // Дата статистики расходов // Массив с расходами по каждому API "result": [ { "api": { "title": "API", "value": "gibdd" }, "count": { "title": "Количество операций", "value": "150" }, "sumPay": { "title": "Оплачено", "value": "75" }, "sumBack": { "title": "Возвращено", "value": "0.5" }, "itogo": { "title": "Итого", "value": 74.5 }, "avgTarif": { "title": "Средний тариф", "value": "0.5" } } ] }
https://api-cloud.ru/api/apilk.php?type=stlastweek&token=53ba1b7a55abbB014aa97eff3a522079
{ "status": 200, // Статус ответа "date_st": "18.06.2024", // Дата начала статистики "date_st_stop": "18.06.2024", // Дата окончания статистики // Массив с расходами по каждому API "result": [ { "api": { "title": "API", "value": "gibdd" }, "count": { "title": "Количество операций", "value": "150" }, "sumPay": { "title": "Оплачено", "value": "75" }, "sumBack": { "title": "Возвращено", "value": "0.5" }, "itogo": { "title": "Итого", "value": 74.5 }, "avgTarif": { "title": "Средний тариф", "value": "0.5" } } ] }
дата | что изменилось |
---|---|
19.07.2024 | Добавлено 2 новых метода: |
19.06.2024 | Добавили метод stlastday, для запроса статистики расходов за предыдущий день. |
28.03.2023 | Добавили метод запроса "performance" для проверки работоспособности API и метода запроса. |
код (error) | Описание ошибки (message) |
---|---|
888 | ИМЯ передаваемой переменной: forbidden symbols present В переменной ИМЯ присутствуют запрещенные символы |
766 | MISSING_MANDATORY_PARAMETER Отсутствуют обязательные параметры |
602 | TOKEN_NO_ACCESS Нет доступа к запрашиваему методу запроса |
504 | TOKEN_LOCKED_IN_THE_SYSTEM Переданный токен заблокирован службой качества / автоматической системой |
503 | TOKEN_NOT_REGISTERED_IN_THE_SYSTEM Переданный токен не зарегистрирован в системе |
502 | MISSING_REQUIRED_TOKEN_PARAMETER Отсутствует параметр token |
500 | MISSING_REQUIRED_TYPE_PARAMETER Отсутствует параметр type |
499 | WRONG_TOKEN_KEY Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа. |
498 | TOKEN_NO_MONEY Для выполнения запроса недостаточно средств, пополните баланс. |
460 | NO_REQUIRED_PARAMETERS Отсутствуют обязательные параметры |
456 | MAX_LIMIT Превышено количество одновременных соединений (потоки) |
404 | TIME_MAX_CONNECT Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже. |
123 | IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК |
111 | PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно. |
015 | DATE_ERROR Ошибка значения переданной даты |
008 | MISSING_REQUIRED_METHOD_PARAMETER Отсутствует параметр method |
007 | MISSING_REQUIRED_API_PARAMETER Отсутствует параметр api |
006 | API_NOT_FOUND Имя переданного API не найдено |
005 | TEST_TIME_OFF Закончился период тестирования |
003 | TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой |
002 | TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности. |
001 | API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже. |
{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}