| Оглавление |
|---|
Общие сведения
Сервисы используют методы GET, POST и PUT, отвечающие стандарту RFC 7231. Путь к сервису должен соответствовать шаблону «api/[version]/[controller]», например, «api/v1/metering_devices». Тело запроса содержит json-объект, соответствующий описанию сервиса, наименования свойств объектов формируются по правилам snake_case. Свойства со значениями по умолчанию исключаются из сериализации. Все операции по лицевым счетам проводятся исключительно по соответствующим платежным кодам. Все запросы должны быть авторизованы, ограничения по данным накладываются в разрезе платежного кода.
...
Аутентификация пользователя | |
Построение заголовка | Basic Base64([платежный код]:[фамилия]@[квартира]) Пример для пользователя с фамилией «Иванов», квартирой «64А» и платежным кодом «810123456»: Password = “иванов@64а” Token = “810123456:иванов@64а” Base64String = “ODEwMTIzNDU2OtC40LLQsNC90L7QskA2NNCw” |
Результат | Authorization: Basic ODEwMTIzNDU2OtC40LLQsNC90L7QskA2NNCw |
...
Обработка ошибок
В качестве ответов для всех сервисов резервируются следующие коды ответов, для каждого из методов набор ошибок может быть расширен:
...