Котерапевт OpenAPI

API организации

Приложение организации читает участников, клиентов, назначения и расписание одного дня. Ответ ограничен уровнем A: идентификаторы, инициалы, роли, статусы, даты и код методики.

Чтение

Участники

GET /api/v1/members

Операция members.list, scope org:read.

В строке идентификатор членства, идентификатор пользователя, роль (owner, admin, psychologist), статус (active, invited, suspended) и инициалы. Имя и почта не приходят.

Клиенты

GET /api/v1/clients

GET /api/v1/clients/{id}

Операции clients.list и clients.show, scope clients:read.

В карточке идентификатор и инициалы. Архивные клиенты в список не попадают. Неизвестный и чужой идентификатор отвечают одним и тем же 404.

Назначения

GET /api/v1/assignments

Операция assignments.list, scope assignments:read.

В строке идентификатор назначения, идентификатор клиента, код методики, статус pending или completed, даты создания, открытия, начала и отмены. Гостевая ссылка, баллы и ответы не приходят.

День расписания

GET /api/v1/schedule

Операция schedule.day, scope schedule:read.

Нужен query date в виде YYYY-MM-DD. В строке время начала и конца, статус, идентификатор психолога и инициалы клиента. Имени клиента, заметок и ссылок на управление встречей нет.

Токен

Каждый запрос передаёт токен заголовком Authorization: Bearer. Токен выпускает POST /oauth/token с grant_type=client_credentials на этом же хосте.

Токен уже принадлежит одной организации. Параметр organization_id в запросе её не подменяет.

Чтение ограничено 60 запросами в минуту на приложение.

Страницы списков

Списки участников, клиентов и назначений принимают page и per_page. По умолчанию первая страница и 25 строк. Больше 100 строк за запрос не отдаётся. В ответе есть items и число страниц pages.

Коды ответа

401
Токена нет или он недействителен.
403
У токена нет scope операции, либо организации недоступен этот API. Смена тарифа отклоняет уже выданный токен тем же кодом.
404
Записи нет в организации токена. Чужой идентификатор выглядит так же.
422
Неверные page, per_page или date.

Потолок уровня A

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

Машиночитаемый контракт: OpenAPI.