OData API

WorkPoint реализует OData v4 API для интеграции с другими системами.

Open Data Protocol (OData) — это открытый веб-протокол для запроса и обновления данных. Протокол позволяет выполнять операции с ресурсами, используя в качестве запросов HTTP-команды, и обмениваться данными в форматах JSON или XML.

OData является одним из лучших стандартов для создания RESTful API.

Чтение данных:

  • Получение коллекции сущностей, отдельной сущности или свойства;
  • Поиск по критериям («меньше», «больше» и т.п.), возможность построения сложных условий, используя логические выражения;
  • Поиск по связям (по связанным объектам);
  • Получение составных сложных объектов.

Модификация данных:

  • Добавление простых объектов;
  • Модификация отдельных свойств (полей);
  • Замена объекта целиком на новый;
  • Удаление объектов.

                
[GET] /OData/Projects?$select=Name,Code&$expand=Manager($select=Name)

[  
 {
    "Name": "Тех. поддержка Сибур 2018",
    "Code": "SUP-02-2018",
    "Manager": {
      "Name": "Иван Агафонов"
    }
  },
  {
    "Name": "Развертывание CRM",
    "Code": "IMP-01-2018",
    "Manager": {
      "Name": "Иван Агафонов"
    }
  },
  {
    "Name": "Финансовый модуль ERP - развертывание",
    "Code": "IMP-03-2018",
    "Manager": {
      "Name": "Иван Агафонов"
    }
  }
]

OAuth-авторизация

WorkPoint поддерживает надежный и безопасный протокол авторизации OAuth 2.0:

  • Получение токена доступа и обновления по логину/паролю;
  • Обновление токенов доступа;
  • Авторизация запросов к API с помощью токена доступа.
Схема аутентификации в API WorkPoint

Попробуйте бесплатно

Уже зарегистрированы? — Войти.