Welcome!

API-интерфейс предназначен для обмена данными между сервисами FreshOffice и внешними клиентами.

Доступ к API осуществляется по протоколу Open Data Protocol. OData — это стандартизованный протокол, специально предназначенный для использования в системах API.

Приведённые в описании примеры иллюстрируют некоторые полезные возможности OData в части выборки и представления данных, однако сами по себе эти примеры не являются достаточными для полного понимания принципов работы OData.

В большинстве случаев FreshOffice API соответствует протоколу OData, за исключением следующих моментов:

  • Вывод данных осуществляется только в формате JSON, форматы XML и ATOM не поддерживаются;

  • Поля метаданных ("__metadata") и связанных сущностей ("__deferred") не выводятся;

Внимание: документация описывает устройство новой версии API, расположенного по адресу do.myfreshcloud.com Если вы используете предыдущею версию API api.myfreshcloud.com, документация здесь https://freshofficeapi.docs.apiary.io/#

Last updated