Перейти к основному содержимому

Введение в API

Информация о разделе​

Интеграционное API представляет собой набор REST методов, сгруппированных по основному функционалу системы Астрал.ЭДО.

Сервис API расположен по адресу https://api.doc.astral.ru.

Сценарии использования​

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

  • Единичный (без состояния) - сценарии использования API, предусматривающие работу для единичных клиентов (одна организация), не хранящих информацию на своей стороне (работа происходит в режиме опроса - тонкий клиент).

Сценарии использования содержат кросс-ссылки на контроллеры для более удобной ориентации среди доступных методов.

Контроллеры API​

Контроллер API – группа методов, направленная на работу с функциями Астрал ЭДО.

  • Counterparties API - предназначен для работы со списоком контрагентов и приглашениями (адресной книгой);
  • Cryptography API - предназначен для работы с криптографией при обмене документами;
  • Docflows Actions API - предназначен для выполнения действий над документооборотом;
  • Docflows API - предназначен для работы со списком документооборотов, а также получения информации по ним;
  • Drafts API - предназначен для работы с черновиками.