В основе Condo API лежит модель предметной области, состоящая из объектов и связей между ними.
Мы используем GraphQL в качестве стандарта построения запросов и манипулирования данными.
Если вы умеете делать обычные HTTP API запросы и работать с JSON, то у вас не должно возникнуть особых сложностей.
Базовые атрибуты объекта
Наше API строится вокруг бизнес объектов или объектов предметной области (domain object).
У каждого объекта есть набор обязательных атрибутов:
| Название атрибута | Описание атрибута |
|---|---|
| id | уникальный идентификатор объекта |
| __typename | GraphQL тип объекта |
Помимо этого, у всех объектов есть ряд служебных атрибутов:
| Название атрибута | Описание атрибута |
|---|---|
| createdAt | Дата создания объекта, которую нельзя подменить. Задается автоматически. |
| updatedAt | Дата последнего обновления объекта, которую нельзя подменить. Задается автоматически. |
| deletedAt | Дата удаления объекта. Имеет значение null, если объект не удален. |
| createdBy | Ссылка но пользователя, создавшего объект. Нельзя подменить, задается автоматически. |
| newId | Идентификатор объекта, оставшегося после склейки объектов |
| dv | Версия структуры данных. |
| v | Версия данных, представляющая из себя счетчик, увеличивающийся при любом изменении объекта. |
| importId | Идентификатор внешней системы, используется при импорте данных в наш сервис из других систем. |
Методы для работы с объектами
Для всех объектов определен стандартный набор методов работы с ними:
- Получение всех объектов данного типа (query
allObjects) - Создание нового объекта данного типа (mutation
createObject) - Обновление существующего объекта (mutation
updateObject)
Для конкретного типа объекта часть с
Object меняется на тип данного объекта. Пример: allContacts, createTicket, updateUserКак мне в этом разобраться?
Мы подготовили инструмент, который позволяет облегчить жизнь разработчика при работе с нашим API.
Чтобы сориентироваться в нашем API, советуем пройти пошаговую инструкцию по работе с API Playground.
Однако, проще всего разобраться, рассмотрев примеры, описанные в данном разделе.