REST API сервера

Ниже перечисленны некоторые основные принципы построения REST API сервера. Частью так же затрагиваются и вопросы построения законченных решений на базе сервера

  • Каждый модуль самостоятельно определяет те ресурсы, которые он готов передоставить.
  • Ресурсы сервера не рекомендуется публиковать. Вместо этого публикуйте ресурсы Вашего приложения
  • Все справочники/регистры/документы подлежещие репликации должны иметь REST API

Хотя все ресурсы сервера могут быть опубликованы и к ним может быть получен доступ посредством протокола HTTP/HTTPS, этого настоятельно не рекомендуется делать, в связи с тем, что сервер не имеет ролевой авторизации, предоставля ее реализацию приложениям на своей основе. Прямая публикация ресурсов сервера может быть использована в строго ограниченных вариантах использования и только в случае, если клиентом является доверенное ПО.

Вместо публикации ресурсов сервера разработчикам рекомендуется определить свои собственные классы ресурсов, производные от ресурсов сервера, с определениями доступа к данным в соответствии с той бизнес-моделью, котороая им требуется

Далеко не все справочники/регистры/документы имеют REST API, однако все подлежащие репликации - имеют. Это связанно с тем, что процесс репликации сам использует API сервера для своей работы. Онако, в отличии от клиентов сервера, ему для этого не нужен протокол HTTP/HTTPS, и следовательно, он не нуждается в публикации ресурсов.