Дерево страниц

SAYMON документация

Перейти к концу метаданных
Переход к началу метаданных

SAYMON API

SAYMON API относится к категории REpresentational State Transfer (REST). Это значит, что вы можете выполнять RESTful-операции на добавление, чтение, изменение и удаление информации для своей облачной учетной записи или инсталляции на своем сервере.

Описания методов можно найти тут: https://saas.saymon.info/apidoc/

Что позволяет SAYMON API?

Любые операции или действия, доступные в веб-интерфейсе системы, могут быть реализованы с помощью API, например:

Какие API-методы доступны?

API платформы реализован как "JSON over HTTP" и предоставляет возможность использовать следующие методы:

МетодНазначение
GETПолучение данных о существующих объектах
POSTСоздание новых объектов
PUTОбновление и изменение существующих объектов
PATCHОбновление и изменение существующих объектов
DELETEУдаление существующих объектов

Права на выполнение операций

Доступ к данным и возможность выполнения тех или иных операций зависят от соответствующих прав учетной записи пользователя.

Аутентификация

Ниже описаны несколько способов, которые можно использовать для аутентификации при работе с API системы.

Basic Access Authorization

Допустим, ваш логин login, а пароль password. Система позволяет использовать basic auth, например, следующим образом:

curl -v -u login:password -H "Content-Type: application/json" -X GET https://your.server.name/node/api/users/current

Session ID (Cookie)

Допустим, ваш логин login, а пароль password. Система позволяет использовать сохранять идентификатор сессии, например в cookie, и использовать его в последующих запросах:

curl
curl -v --cookie-jar cookies.txt -H "Content-Type: application/json" -X POST --data '{"login": "login", "password": "password"}' https://your.server.name/node/api/users/session
curl -v --cookie cookies.txt -H "Content-Type: application/json" -X GET https://your.server.name/node/api/users/current
ajax
$.ajax
({
  type: "POST",
  url: "https://your.server.name/node/api/users/session",
  dataType: 'json',
  async: true,
  data:
  {
    "login": "login",
    "password": "password"
  },
  success: function (res){
    console.log('Thanks for your login!'); 
    console.log('Session ID:'+res);
  },
  error: function () {
    console.log('Login failed!');
  }
});

API Key (API Token)

Допустим, ваш логин login, а пароль password:

  • войдите в веб-интерфейс системы;
  • нажмите на кнопку с названием учетной записи в правом верхнем углу;
  • откройте страницу Конфигурации.

Ваш API-токен будет указан в поле Ссылка для Авторизации - https://your.server.name/?auth-token=52cc80e1-e2d8-4cff-a242-dfcfb538b585. Используйте его в каждом запросе:

curl -v -H "Content-Type: application/json" -X GET https://your.server.name/node/api/users/current?api-token=52cc80e1-e2d8-4cff-a242-dfcfb538b585
  • Нет меток