API-шлюз

Принцип работы, адрес, формат данных

API-шлюз хранилища данных реализует спецификацию RESTful – это стиль архитектуры программного обеспечения для распределенных систем, таких как World Wide Web, который, как правило, используется для построения веб-служб

Доступ к программному интерфейсу (API RESTful) осуществляется по адресу:

http(s)://домен/проект/api/v1/

Например: https://buildbox.app/buildbox/api/v1/

По корневому адресу выводится текущее состояние API:

{
    "cachecount": "",   - количество объектов в кеше (если используется)
    "cachesource": "",  - адрес кеша (если используется)
    "cachestatus": "",   - статус состояния кеша (если используется)
    "namespace": "", - имя проекта
    "storagedriver": "", - драйвер хранилища
    "storagesource": "" - строка подключения к базе хранилища
}

Текущая версия API: v1

Связи объектов (получить)

/gui/links

Существует два вида связей: входящие и исходящие.

Исходящие связи - это ссылки данного объекта на другие объекты.

Входящие связи - это ссылки других объектов на текущий объект.

Формат возвращаемых данных

Все возвращаемые данные соответствуют формату хранения данных в Buildbox Database.

Подробнее можете прочитать тут