Общее описание API Analytics
API – набор функций, помогающий понять, каким способом возможно обратиться к программе, включает в себя:
Операцию, которую можно выполнить
Данные, которые поступают на вход
Данные, которые оказываются на выходе (контент данных или сообщение об ошибке)
API продуктов VSaaS организован на основе REST.
REST API отвечает почти за все взаимодействия между серверными и клиентскими приложениями (серверное приложение дает доступ к своим данным клиентскому приложению по определенному URL).
API продукта Analytics имеет предсказуемые URL-адреса, ориентированные на ресурсы, возвращает ответы в формате JSON, использует стандартные коды ответов HTTP.
Все запросы должны иметь заголовок: Content-Type: application/json
Это необходимо для того, чтобы backend понимал, поддерживает ли клиент ответы в формате json.