Разработчики · REST API

Опираться на
Mewayz.

Один REST API для всего вашего рабочего пространства — CRM, продажи, выставление счетов, бухгалтерский учет, проекты, POS, HR и многое другое. 372 конечных точки, повсюду JSON, аутентифицированные с помощью токена на предъявителя. Тот же самый доступный для просмотра справочник находится в приложении под Настройки → Документация по API.

Базовый URL · app.mewayz.com/api Авторизация · Токен на предъявителя Формат · JSON Конечные точки · 372

Аутентификация

Каждый запрос аутентифицируется с помощью токена на предъявителя. Создайте его на своей панели управления в разделе Настройки → Ключи API — оно показано один раз, поэтому скопируйте его. Токен наследует роли и разрешения пользователя, который его создал, и для большинства конечных точек ресурсов также требуется, чтобы соответствующий модуль был включен в вашем плане.

Заголовок авторизации
# Передайте свой токен при каждом запросе локон https://app.mewayz.com/api/leads \ -Ч «Авторизация: носитель 12|aZ8f3a...d92c» \ -Ч «Принять: приложение/json»

Предпочитаете проходить аутентификацию программно? POST/api/логин с вашим адресом электронной почты и паролем возвращает токен на предъявителя, который вы можете использовать таким же образом, и POST/api/обновить вращает его.

Быстрый старт

Создайте CRM-лида менее чем за минуту. API работает с теми же данными, которые вы видите в продукте — отдельного уровня синхронизации нет.

POST/api/lead/создать
завиток -X ПОСТ https://app.mewayz.com/api/lead/create \ -Ч "Авторизация: носитель 12|aZ8f3a..." \ -Ч «Тип контента: приложение/json» \ -Ч «Принять: приложение/json» \ -д '{ "name": "Ада Лавлейс", "электронная почта": "[email protected]" }'

Ошибки и коды состояния

Мы используем обычные коды состояния HTTP. Тела ошибок включают в себя удобочитаемый текст. сообщение вы можете всплыть прямо.

200ОК — запрос выполнен успешно
201Создано — ресурс создан.
401Неавторизованный — токен отсутствует или недействителен.
422Необработано — проверка не удалась
429Слишком много запросов — вы достигли лимита скорости.
500Ошибка сервера — мы включим это статус

Ограничения ставок

Трафик API ограничен по скорости, чтобы платформа была быстрой для всех. Если вы превысите лимит, вы получите HTTP 429 ответ — отступите и повторите попытку. Повторить попытку после заголовок сообщает вам, когда вы сможете возобновить работу.

Аутентификация и сеанс /api/логин

Войдите в систему, обновите или отзовите свой токен, выберите вошедшего пользователя, отредактируйте профиль и прочитайте списки пользователей сотрудников/клиентов/поставщиков. (11 конечных точек)

ПОСТ/api/изменить-пароль
ПОЛУЧИТЬ/api/клиент-пользователь
УДАЛИТЬ/api/удалить-аккаунт
ПОСТ/api/edit-профиль
ПОСТ/api/логин
ПОСТ/api/выйти
ПОСТ/api/обновить
ПОЛУЧИТЬ/api/сотрудник-пользователь
ПОСТ/api/загрузить-фото
ПОЛУЧИТЬ/api/пользователь
ПОЛУЧИТЬ/api/пользователь-поставщик

Ключи API /api/v1/settings/api-keys

Перечисляйте, создавайте и отзывайте свои личные токены доступа — те же ключи, которые вы создаете в разделе «Настройки» → «Ключи API». (3 конечных точки)

ПОЛУЧИТЬ/api/v1/settings/api-keys
ПОСТ/api/v1/settings/api-keys
УДАЛИТЬ/api/v1/settings/api-keys/{id}

CRM — лиды, сделки и воронка продаж /api/лиды

Полный CRUD по лидам, сделкам, конвейерам, этапам, меткам и источникам, а также их задачам, звонкам, файлам, заметкам и продуктам. (79 конечных точек)

УДАЛИТЬ/api/deal-call/delete/{call_id}
ПОСТ/api/deal-call/store
ПОСТ/api/deal-call/update/{call_id}
ПОСТ/api/deal-client/store/{deal_id}
УДАЛИТЬ/api/deal-client/{deal_id}/delete/{client_id}
ПОСТ/api/deal-discussion/store/{deal_id}
ПОСТ/api/deal-email/store/{deal_id}
ПОСТ/api/deal-file/store/{deal_id}
УДАЛИТЬ/api/deal-file/{deal_id}/delete/{file_id}
ПОСТ/api/deal-source/store/{deal_id}
УДАЛИТЬ/api/deal-source/{deal_id}/delete/{source_id}
ПОСТ/api/deal-stage/create
УДАЛИТЬ/api/deal-stage/delete/{id}
ПОСТ/api/deal-stage/update/{id}
ПОЛУЧИТЬ/api/этапы сделки
ПОСТ/api/сделка-задача/создать
УДАЛИТЬ/api/deal-task/delete/{id}
ПОСТ/api/deal-task/update/{id}
ПОСТ/api/deal-user/store/{deal_id}
УДАЛИТЬ/api/deal-user/{deal_id}/delete/{user_id}
ПОСТ/api/deal/add-label/{id}
ПОСТ/api/deal/assign-products/{deal_id}
ПОСТ/api/сделка/создать
УДАЛИТЬ/api/deal/delete/{id}
ПОЛУЧИТЬ/api/deal/show/{id}
ПОСТ/api/deal/update/{id}
УДАЛИТЬ/api/deal/{deal_id}/products/{product_id}
ПОЛУЧИТЬ/api/сделки
ПОСТ/api/метка/создать
УДАЛИТЬ/api/label/delete/{id}
ПОСТ/api/label/update/{id}
ПОЛУЧИТЬ/api/метки
УДАЛИТЬ/api/lead-call/delete/{call_id}
ПОСТ/api/lead-call/store
ПОСТ/api/lead-call/update/{call_id}
ПОСТ/api/lead-discussion/store/{lead_id}
ПОСТ/api/lead-email/store/{lead_id}
ПОСТ/api/lead-file/store/{lead_id}
УДАЛИТЬ/api/lead-file/{lead_id}/delete/{file_id}
ПОСТ/api/lead-source/store/{lead_id}
УДАЛИТЬ/api/lead-source/{lead_id}/delete/{source_id}
ПОСТ/api/lead-stage/создать
УДАЛИТЬ/api/lead-stage/delete/{id}
ПОСТ/api/lead-stage/update/{id}
ПОЛУЧИТЬ/api/lead-stages
ПОСТ/api/lead-task/создать
УДАЛИТЬ/api/lead-task/delete/{id}
ПОСТ/api/lead-task/update/{id}
ПОСТ/api/lead-user/store/{lead_id}
УДАЛИТЬ/api/lead-user/{lead_id}/delete/{user_id}
ПОСТ/api/lead/add-label/{id}
ПОСТ/api/lead/assign-products/{lead_id}
ПОСТ/api/lead/convert-to-deal/{id}
ПОСТ/api/lead/create
УДАЛИТЬ/api/lead/delete/{id}
ПОЛУЧИТЬ/api/lead/get-request-data
ПОЛУЧИТЬ/api/lead/get-users
ПОСТ/api/lead/home
ПОСТ/api/lead/lead-create-update
ПОСТ/api/lead/lead-delete
ПОСТ/api/lead/lead-details
ПОСТ/api/lead/lead-stage-create-update
ПОСТ/api/lead/lead-stage-update
ПОСТ/api/lead/lead-stages
ПОСТ/api/lead/leadboard
ПОСТ/api/lead/pipeline-create-update
ПОЛУЧИТЬ/api/lead/pipelines
ПОЛУЧИТЬ/api/lead/show/{id}
ПОСТ/api/lead/update/{id}
УДАЛИТЬ/api/lead/{lead_id}/products/{product_id}
ПОЛУЧИТЬ/api/лиды
ПОСТ/api/конвейер/создать
УДАЛИТЬ/api/pipeline/delete/{id}
ПОСТ/api/pipeline/update/{id}
ПОЛУЧИТЬ/api/трубопроводы
ПОСТ/api/источник/создать
УДАЛИТЬ/api/source/delete/{id}
ПОСТ/api/source/update/{id}
ПОЛУЧИТЬ/api/источники

Продажи /api/sales/заказы на продажу

Возможности, котировки, встречи, заказы на продажу и поиск складов. (23 конечных точки)

ПОЛУЧИТЬ/api/sales/RequestData
ПОСТ/api/sales/get-warehouse-products
ПОЛУЧИТЬ/api/продажи/домой
УДАЛИТЬ/api/sales/meeting/destroy/{id}
ПОСТ/api/продажи/встречи/магазин
ПОСТ/api/sales/meeting/update/{id}
ПОЛУЧИТЬ/api/продажи/встречи
ПОЛУЧИТЬ/api/продажи/возможности
УДАЛИТЬ/api/sales/opportunities/delete/{id}
ПОСТ/api/sales/opportunities/update/{id}
ПОСТ/api/продажи/возможности/магазин
ПОСТ/api/sales/parent-records
ПОЛУЧИТЬ/api/продажи/котировки
УДАЛИТЬ/api/sales/quotes/destroy/{id}
ПОСТ/api/sales/quotes/store
ПОСТ/api/sales/quotes/update/{id}
ПОЛУЧИТЬ/api/sales/quotes/{id}
УДАЛИТЬ/api/sales/sales-order/delete/{id}
ПОСТ/api/sales/заказ на продажу/магазин
ПОСТ/api/sales/sales-order/update/{id}
ПОЛУЧИТЬ/api/sales/заказы на продажу
ПОЛУЧИТЬ/api/sales/sales-orders/{id}
ПОЛУЧИТЬ/api/продажи/склады

Предложения по продаже /api/торговое предложение

Составляйте, отправляйте, принимайте/отклоняйте предложения и преобразуйте их в счета. (9 конечных точек)

ПОЛУЧИТЬ/api/торговое предложение
ПОСТ/api/sales-proposal/accept/{proposal_id}
ПОСТ/api/sales-proposal/convert-to-invoice/{proposal_id}
ПОСТ/api/торговое предложение/создать
УДАЛИТЬ/api/sales-proposal/delete/{proposal_id}
ПОСТ/api/sales-proposal/reject/{proposal_id}
ПОСТ/api/sales-proposal/sent/{proposal_id}
ПОЛУЧИТЬ/api/sales-proposal/show/{proposal_id}
ПОСТ/api/sales-proposal/update/{proposal_id}

Счета за продажу /api/счет-продажа

Составляйте список, создавайте, обновляйте, удаляйте и учитывайте счета-фактуры по продажам. (6 конечных точек)

ПОЛУЧИТЬ/api/счет-продажа
ПОСТ/api/счет-фактура/создать
УДАЛИТЬ/api/sales-invoice/delete/{invoice_id}
ПОСТ/api/sales-invoice/post/{invoice_id}
ПОЛУЧИТЬ/api/sales-invoice/show/{invoice_id}
ПОСТ/api/sales-invoice/update/{invoice_id}

Возврат счетов-фактур /api/продажный счет-возврат

Создавайте, утверждайте и заполняйте возвраты счетов-фактур. (6 конечных точек)

ПОЛУЧИТЬ/api/продажный счет-возврат
ПОСТ/api/sales-invoice-return/approve/{return_id}
ПОСТ/api/sales-invoice-return/complete/{return_id}
ПОСТ/api/sales-invoice-return/create
УДАЛИТЬ/api/sales-invoice-return/delete/{return_id}
ПОЛУЧИТЬ/api/sales-invoice-return/show/{return_id}

Счета за покупку /api/покупка-счет

Составляйте список, создавайте, обновляйте, удаляйте и разносите счета-фактуры на покупку. (6 конечных точек)

ПОЛУЧИТЬ/api/покупка-счет
ПОСТ/api/покупка-счет/создать
УДАЛИТЬ/api/purchase-invoice/delete/{invoice_id}
ПОСТ/api/purchase-invoice/post/{invoice_id}
ПОЛУЧИТЬ/api/purchase-invoice/show/{invoice_id}
ПОСТ/api/purchase-invoice/update/{invoice_id}

Возврат покупок /api/покупка-возврат

Создавайте, утверждайте и заполняйте возвраты покупок. (6 конечных точек)

ПОЛУЧИТЬ/api/покупка-возврат
ПОСТ/api/purchase-return/approve/{return_id}
ПОСТ/api/purchase-return/complete/{return_id}
ПОСТ/api/purchase-return/создать
УДАЛИТЬ/api/purchase-return/delete/{return_id}
ПОЛУЧИТЬ/api/purchase-return/show/{return_id}

Бухгалтерский учет /api/план счетов

Клиенты, поставщики, банковские счета, план счетов, доходы, расходы, платежи, кредитовые/дебетовые авизо и переводы. (37 конечных точек)

ПОЛУЧИТЬ/api/типы учетных записей
ПОЛУЧИТЬ/api/банковские счета
ПОСТ/api/банковские счета/создать
УДАЛИТЬ/api/bank-accounts/delete/{id}
ПОСТ/api/bank-accounts/update/{id}
ПОЛУЧИТЬ/api/банковские транзакции
ПОЛУЧИТЬ/api/банковские переводы
ПОЛУЧИТЬ/api/план счетов
ПОЛУЧИТЬ/api/кредит-ноты
ПОЛУЧИТЬ/api/клиентские платежи
ПОЛУЧИТЬ/api/клиенты
ПОСТ/api/клиенты/создать
УДАЛИТЬ/api/customers/delete/{id}
ПОСТ/api/customers/update/{id}
ПОЛУЧИТЬ/api/дебетовые заметки
ПОЛУЧИТЬ/api/expense-categories
ПОЛУЧИТЬ/api/расходы
ПОСТ/api/expenses/approve/{id}
ПОСТ/api/расходы/создать
УДАЛИТЬ/api/expenses/delete/{id}
ПОСТ/api/expenses/post/{id}
ПОСТ/api/expenses/update/{id}
ПОЛУЧИТЬ/api/get-клиенты
ПОЛУЧИТЬ/api/get-vendors
ПОЛУЧИТЬ/api/gl-аккаунты
ПОЛУЧИТЬ/api/категории доходов
ПОЛУЧИТЬ/api/доходы
ПОСТ/api/revenues/approve/{id}
ПОСТ/api/доходы/создать
УДАЛИТЬ/api/revenues/delete/{id}
ПОСТ/api/revenues/post/{id}
ПОСТ/api/revenues/update/{id}
ПОЛУЧИТЬ/api/vendor-платежи
ПОЛУЧИТЬ/api/поставщики
ПОСТ/api/vendors/создать
УДАЛИТЬ/api/vendors/delete/{id}
ПОСТ/api/vendors/update/{id}

Продукты и услуги /api/продукты

Товары, категории, налоги, единицы и запасы. (20 конечных точек)

ПОЛУЧИТЬ/api/продукт-сервис/предметы
ПОСТ/api/product-stock/добавить
ПОЛУЧИТЬ/api/продукт-запасы
ПОЛУЧИТЬ/api/продукт/категория
ПОСТ/api/продукт/категория/создать
УДАЛИТЬ/api/product/category/delete/{id}
ПОСТ/api/product/category/update/{id}
ПОСТ/api/продукт/создать
УДАЛИТЬ/api/product/delete/{id}
ПОЛУЧИТЬ/api/product/detail/{id}
ПОСТ/api/product/update/{id}
ПОЛУЧИТЬ/api/продукты
ПОЛУЧИТЬ/api/налог
ПОСТ/api/tax/создать
УДАЛИТЬ/api/tax/delete/{id}
ПОСТ/api/tax/update/{id}
ПОСТ/api/unit/создать
УДАЛИТЬ/api/unit/delete/{id}
ПОСТ/api/unit/update/{id}
ПОЛУЧИТЬ/api/единицы

Склад и инвентарь /api/склад

Склады и перемещение товаров. (9 конечных точек)

ПОЛУЧИТЬ/api/перенос
ПОСТ/api/перенос/создать
УДАЛИТЬ/api/transfer/delete/{transfer_id}
ПОЛУЧИТЬ/api/transfer/запрос-данных
ПОЛУЧИТЬ/api/склад
ПОСТ/api/склад/создать
УДАЛИТЬ/api/warehouse/delete/{warehouse_id}
ПОЛУЧИТЬ/api/warehouse/product/{warehouse_id}
ПОСТ/api/warehouse/update/{warehouse_id}

Проекты, задачи и ошибки /api/проекты

Проекты, вехи, доски задач, задачи, подзадачи, ошибки и отчеты. (45 конечных точек)

ПОЛУЧИТЬ/api/список-статусов ошибок
ПОЛУЧИТЬ/api/get-проекты
ПОСТ/api/project/bug-stage/create
УДАЛИТЬ/api/project/bug-stage/delete/{id}
ПОСТ/api/project/bug-stage/order
ПОСТ/api/project/bug-stage/update/{id}
ПОЛУЧИТЬ/api/project/bug-stages
ПОСТ/api/project/bug/create/{project_id}
ПОЛУЧИТЬ/api/project/bug/show/{bug_id}
ПОСТ/api/project/bug/{bug_id}/comment/create
УДАЛИТЬ/api/project/bug/{id}/comment/delete
ПОЛУЧИТЬ/api/project/bug/{project_id}
УДАЛИТЬ/api/project/client/delete/{id}
ПОСТ/api/проект/клиент/приглашение
ПОЛУЧИТЬ/api/проект/клиенты
УДАЛИТЬ/api/project/delete/{id}
ПОСТ/api/проект/файл/создать
УДАЛИТЬ/api/project/file/delete/{id}
УДАЛИТЬ/api/project/member/delete/{id}
ПОСТ/api/project/milestone/create
УДАЛИТЬ/api/project/milestone/delete/{id}
ПОСТ/api/project/milestone/update/{id}
ПОЛУЧИТЬ/api/проект/вехи
ПОЛУЧИТЬ/api/project/report/{id}
ПОЛУЧИТЬ/api/проект/отчеты
ПОЛУЧИТЬ/api/project/show/{id}
ПОСТ/api/project/task-stage/create
УДАЛИТЬ/api/project/task-stage/delete/{id}
ПОСТ/api/project/task-stage/order
ПОСТ/api/project/task-stage/update/{id}
ПОЛУЧИТЬ/api/project/task-stages
ПОСТ/api/project/task-subtask/create/{task_id}
ПОСТ/api/project/task-subtask/update/{subtask_id}
УДАЛИТЬ/api/project/task/comment/delete/{comment_id}
ПОЛУЧИТЬ/api/project/task/show/{id}
ПОСТ/api/project/task/{task_id}/comment/create
ПОСТ/api/project/update/{id}
ПОЛУЧИТЬ/api/project/{id}/task-board
ПОСТ/api/project/{id}/task/create
ПОСТ/api/project/{id}/task/update/{task_id}
УДАЛИТЬ/api/project/{project_id}/bug/delete/{bug_id}
ПОСТ/api/project/{project_id}/bug/update/{bug_id}
УДАЛИТЬ/api/project/{project_id}/task/delete/{task_id}
ПОЛУЧИТЬ/api/проекты
ПОСТ/api/проекты/создать

Точка продажи /api/pos

POS-заказы и детали заказа. (2 конечные точки)

ПОЛУЧИТЬ/api/pos
ПОЛУЧИТЬ/api/pos/show/{id}

Служба поддержки /api/support-ticket/билеты

Заявки и ответы, часто задаваемые вопросы и статьи базы знаний. (16 конечных точек)

ПОСТ/api/support-ticket/faq/delete/{faq_id}
ПОСТ/api/support-ticket/faq/update/{faq_id}
ПОЛУЧИТЬ/api/support-ticket/часто задаваемые вопросы
ПОСТ/api/support-ticket/часто задаваемые вопросы/магазин
ПОЛУЧИТЬ/api/support-ticket/get-request-data
ПОЛУЧИТЬ/api/support-ticket/home
ПОСТ/api/support-ticket/knowledge/delete/{knowledge_id}
ПОСТ/api/support-ticket/knowledge/store
ПОСТ/api/support-ticket/knowledge/update/{knowledge_id}
ПОЛУЧИТЬ/api/support-ticket/knowledges
ПОСТ/api/support-ticket/ticket/add-reply/{ticket_id}
ПОСТ/api/support-ticket/ticket/delete/{ticket_id}
ПОСТ/api/support-ticket/ticket/note/store/{ticket_id}
ПОСТ/api/support-ticket/билет/магазин
ПОСТ/api/support-ticket/ticket/update/{ticket_id}
ПОЛУЧИТЬ/api/support-ticket/билеты

Целенаправленно /api/taskly/проекты

Taskly проекты и задачи для облегченного модуля проектов. (18 конечных точек)

ПОЛУЧИТЬ/api/taskly/домой
ПОСТ/api/taskly/проект-активность
ПОСТ/api/taskly/project-create-update
ПОСТ/api/taskly/project-delete
ПОСТ/api/taskly/детали проекта
УДАЛИТЬ/api/taskly/project-file-delete/{id}
ПОСТ/api/taskly/project-file-upload
ПОСТ/api/taskly/список проектов
ПОСТ/api/taskly/project-status-update
ПОЛУЧИТЬ/api/taskly/проекты
ПОЛУЧИТЬ/api/taskly/projects/{project}/tasks
ПОСТ/api/taskly/task-create-update
ПОСТ/api/taskly/task-delete
ПОСТ/api/taskly/task-details
ПОСТ/api/taskly/список задач
ПОСТ/api/taskly/task-stage-update
ПОСТ/api/taskly/доска задач
ПОЛУЧИТЬ/api/taskly/пользователи

Учет времени /api/добавить-трекер

Запускайте и останавливайте трекеры времени. (3 конечных точки)

ПОСТ/api/добавить-трекер
ПОСТ/api/стоп-трекер
ПОСТ/api/tracker-логин

Пользователи и роли /api/пользователи

Администрирование пользователей рабочей области и чтение ролей. (8 конечных точек)

ПОЛУЧИТЬ/api/роли
УДАЛИТЬ/api/user/delete/{id}
ПОСТ/api/user/reset-password/{id}
ПОСТ/API/пользователь/магазин
ПОСТ/api/user/update/{id}
ПОСТАВИТЬ/api/user/verify/{id}
ПОЛУЧИТЬ/api/пользователи
ПОЛУЧИТЬ/api/пользователи/журнал

Кадры и заработная плата /api/сотрудники

Сотрудники, посещаемость, отпуска, заработная плата, а также полный набор кадровых записей (филиалы, отделы, праздники, награды и многое другое). (44 конечных точки)

ПОЛУЧИТЬ/api/признания
ПОЛУЧИТЬ/api/объявления
ПОСТ/api/attendance/создать
УДАЛИТЬ/api/attendance/delete/{attendance_id}
ПОСТ/api/attendance/update/{attendance_id}
ПОЛУЧИТЬ/api/посещения
ПОЛУЧИТЬ/api/награды
ПОЛУЧИТЬ/api/филиалы
ПОЛУЧИТЬ/api/жалобы
ПОЛУЧИТЬ/api/отделы
ПОЛУЧИТЬ/api/обозначения
ПОЛУЧИТЬ/api/типы документов
ПОЛУЧИТЬ/api/переводы сотрудников
ПОСТ/api/сотрудник/создать
УДАЛИТЬ/api/employee/delete/{id}
ПОЛУЧИТЬ/api/employee/show/{id}
ПОСТ/api/employee/update/{id}
ПОЛУЧИТЬ/api/сотрудники
ПОЛУЧИТЬ/api/события
ПОЛУЧИТЬ/api/праздники
ПОЛУЧИТЬ/api/hrm-документы
ПОСТ/api/hrm/attendence-история
ПОСТ/api/hrm/часы-выход
ПОСТ/api/hrm/события
ПОЛУЧИТЬ/api/hrm/get-leaves
ПОЛУЧИТЬ/api/hrm/get-leaves-types
ПОЛУЧИТЬ/api/hrm/holidays-list
ПОЛУЧИТЬ/api/hrm/домой
ПОСТ/api/hrm/запрос на отпуск
ПОСТ/api/оставить-приложение/создать
УДАЛИТЬ/api/leave-application/delete/{leaveapplication_id}
ПОСТ/api/leave-application/update-status/{leaveapplication_id}
ПОСТ/api/leave-application/update/{leaveapplication_id}
ПОЛУЧИТЬ/api/оставить-приложения
ПОЛУЧИТЬ/api/leave-balances
ПОЛУЧИТЬ/api/leave-типы
ПОЛУЧИТЬ/api/расчеты заработной платы
ПОЛУЧИТЬ/api/payrolls/{payroll_id}
ПОЛУЧИТЬ/api/payslip/{payroll_entry_id}
ПОЛУЧИТЬ/api/промоакции
ПОЛУЧИТЬ/api/отставки
ПОЛУЧИТЬ/api/смены
ПОЛУЧИТЬ/api/завершения
ПОЛУЧИТЬ/api/предупреждения

Сторонний API (v1) /api/v1/клиенты

Стабильный, версионный фрагмент, созданный для таких инструментов без программирования, как Zapier — клиенты и счета. (7 конечных точек)

ПОЛУЧИТЬ/api/v1/клиенты
ПОСТ/api/v1/клиенты
ПОЛУЧИТЬ/api/v1/customers/{id}
ПОСТАВИТЬ/api/v1/customers/{id}
ПОЛУЧИТЬ/api/v1/счета
ПОСТ/api/v1/счета
ПОЛУЧИТЬ/api/v1/invoices/{id}

Публичные конечные точки /api/public/планы

Неаутентифицированные помощники: каталог общедоступных планов, встраиваемый виджет для сбора потенциальных клиентов и значок партнера. (4 конечных точки)

ПОЛУЧИТЬ/api/badge/{токен}
ПОЛУЧИТЬ/api/public/планы
ПОСТ/api/виджет/лид
ПОЛУЧИТЬ/api/виджет/{токен}

Платформа White-label /api/wl/планы

Конечные точки между серверами, используемые экземплярами White Label для выставления счетов и Stripe Connect (с аутентификацией по токену). (6 конечных точек)

ПОСТ/api/wl/checkout
ПОСТ/api/wl/connect/onboard
ПОЛУЧИТЬ/api/wl/connect/статус
ПОЛУЧИТЬ/api/wl/планы
ПОСТ/api/wl/subscription/{stripe_subscription_id}/cancel
ПОСТ/api/wl/webhook-обратный вызов

Конечные точки интеграции /api/microsofttodo

Вспомогательные конечные точки для подключенной интеграции (Microsoft To Do, Vonage SMS, публикации в Facebook). (3 конечных точки)

ПОЛУЧИТЬ/api/facebookpost
ПОЛУЧИТЬ/api/microsofttodo
ПОЛУЧИТЬ/api/vonagesms

Больше конечных точек

Дополнительные зарегистрированные конечные точки. (1 конечная точка)

ПОЛУЧИТЬ/api/agents/{agent}/outstanding-commissions