REST/HTTP сервер API

SberMobile Server поддерживает REST API для интеграции со сторонними системами. Вы можете использовать запросы REST API для работы с переменными контекста, функциями и событиями, а также чтобы вычислять выражения.

В терминах программирования, REST (Representational State Transfer) является архитектурным стилем ПО во всемирной сети Интернет.

Версии REST API

Текущая версия REST API - v1. Предыдущая версия REST API на базе XML может быть устаревшей для будущих версий SberMobile. Если вам нужна документация для старой версии REST API, пожалуйста, напишите на anton.grachevnikov@sberbank-tele.com.

Формат сообщения

REST API использует JSON для представления данных. Передаваемые в запросах и ответах данные имеют формат JSON.

Протоколы HTTP

REST API может использовать протоколы HTTP и HTTPS.

Рекомендуется использовать протокол HTTPS, так как аутентификация REST API происходит на основе токена. Любой, кто отслеживает трафик HTTP, сможет узнать токен и получить те же права доступа, что и владелец токена.

Методы HTTP

REST API поддерживает GET, POST, PUT и PATCH HTTP-методы. Данные методы поддерживают операции retrieve и update на переменных контекста, функциях и выражениях. Операции create и delete нельзя выполнить при помощи REST API.

В программировании, create, read, update, и delete (CRUD) -  четыре базовые функции постоянного хранения.

Коды состояний HTTP

REST API использует стандартные коды состояний HTTP для обозначения результата запроса.

  • 1XX — Информационные ответы
  • 2XX — Успешно
  • 3XX — Перенаправление
  • 4XX — Ошибки клиента
  • 5XX — Ошибки сервера