Перейти к содержимому
14 дней бесплатно, без карты9 языков176 типов бизнеса · 50 приложений
RU· USD
Попробовать живое демоПопробовать бесплатно

Справочник API v1

Каждая точка REST API с методом, путём и нужной областью доступа, сгенерированная из того же документа OpenAPI, который отдаёт API.

GET https://<workspace>.zmle.com/api/v1/me

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

  1. Откройте мгновенное демо: рабочее пространство с примерными данными
  2. В демо откройте Админка → Интеграции и API и создайте ключ
  3. Вызовите GET /api/v1/me с ключом (ниже), чтобы увидеть, к какому пространству и человеку он относится
  4. Добавьте точку вебхука и выберите события; в демо доставки записываются в журнал, но не отправляются

Документ OpenAPI

Полная спецификация открыта; для чтения ключ не нужен: https://zmle.com/api/v1/openapi.json

curl https://<your-demo>.zmle.com/api/v1/me \
  -H "Authorization: Bearer $ZMLE_API_KEY"

Базовый адрес

Каждое рабочее пространство отвечает по своему адресу: https://<workspace>.zmle.com/api/v1 (или по своему домену). Хост API https://api.zmle.com/v1 находит пространство по ключу.

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

Передавайте ключ в Authorization: Bearer <key> (или X-Api-Key). Нативные и подключённые приложения используют OAuth 2.1 с PKCE и короткоживущие токены приложения.

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

Списки принимают page и per (1–100, по умолчанию 25), q для поиска и since для изменений после даты. Ответ содержит total и pages, а также заголовки Link и X-Total-Count.

Ошибки

Ошибки в JSON: { error: { code, message } } с HTTP-статусом. У каждого ответа есть X-Request-Id. Запросы POST принимают заголовок Idempotency-Key. У каждого ключа есть запас в 300 запросов, пополняемый на 5 в секунду; X-RateLimit-Remaining показывает остаток, а 429 приходит с Retry-After.

Версии и вывод из употребления

v1 только растёт: добавляются новые маршруты и поля, внутри v1 ничего не удаляется и не переименовывается. Маршрут, который будет убран, помечается устаревшим не менее чем за 12 месяцев до отключения; до тех пор он работает без изменений и отвечает с заголовками Deprecation и Sunset.

Клиент TypeScript

Готовится официальный клиент TypeScript, сгенерированный из документа OpenAPI (типизированные методы, повторы с учётом Retry-After, ключи идемпотентности, постраничный вывод). До его публикации с openapi.json работает любой генератор OpenAPI.

Коды ошибок

СтатусКодЗначение
400invalid_jsonТело не является корректным JSON
401unauthenticatedКлюч или токен не передан
401invalid_keyКлюч неизвестен, отозван или истёк, либо MCP-токен использован с REST API
401token_expiredТокен приложения истёк: обновите его
403insufficient_scopeУ ключа нет нужной для маршрута области
403forbiddenВладелец ключа не может открыть этот раздел или запись
403origin_not_allowedВызов из браузера с сайта, которого нет среди разрешённых источников пространства
403ip_not_allowedЭтого адреса нет в списке разрешённых IP ключа
403test_mode_read_onlyТестовый ключ пытался изменить данные: тестовые ключи только читают
404not_foundТакой записи или маршрута в этом пространстве нет
409conflictЗапрос противоречит текущему состоянию, например дубликат
422validation_failedПоля не прошли проверку; ответ перечисляет ошибки по каждому полю
429rate_limitedСлишком много запросов: подождите столько секунд, сколько указано в Retry-After
500internal_errorСбой на нашей стороне: повторите позже и укажите X-Request-Id, если обратитесь к нам

Справочник ниже на английском, как и документ OpenAPI.

Customers

МетодПутьОбластьЧто делает
GET/api/v1/customerscustomers:readList customers
GET/api/v1/customers/{id}customers:readRead a customer
POST/api/v1/customerscustomers:writeCreate a customer (an existing e-mail / phone returns that customer)
PATCH/api/v1/customers/{id}customers:writeUpdate a customer's contact details

Leads

МетодПутьОбластьЧто делает
GET/api/v1/inquiriesinquiries:readList leads
GET/api/v1/inquiries/{id}inquiries:readRead a lead
POST/api/v1/inquiriesinquiries:writeCreate a lead (contact, quote request, booking request, call-back) — notifies the team like the website form

Quotations

МетодПутьОбластьЧто делает
GET/api/v1/quotationsquotations:readList quotations
GET/api/v1/quotations/{id}quotations:readRead a quotation with its lines
POST/api/v1/quotationsquotations:writeCreate a DRAFT quotation (tax computed by the workspace's rules)

Invoices

МетодПутьОбластьЧто делает
GET/api/v1/invoicesinvoices:readList invoices
GET/api/v1/invoices/{id}invoices:readRead an invoice with lines and payments
POST/api/v1/invoicesinvoices:writeCreate a DRAFT invoice (numbered when issued in the back office)
GET/api/v1/paymentspayments:readList invoice payments (invoice=<id> to filter)
GET/api/v1/payments/{id}payments:readRead a payment

Orders

МетодПутьОбластьЧто делает
GET/api/v1/ordersorders:readList shop orders
GET/api/v1/orders/{id}orders:readRead a shop order

Catalog

МетодПутьОбластьЧто делает
GET/api/v1/productsproducts:readList products with price and stock (catalog:read also allows it)
GET/api/v1/products/{id}products:readRead a product
GET/api/v1/categoriescatalog:readList categories (type=product|service|post|project, locale=…) (размещённые пространства)
GET/api/v1/servicescatalog:readList published services (размещённые пространства)
GET/api/v1/services/{id}catalog:readRead a service (размещённые пространства)
GET/api/v1/products/lookupproducts:readExact barcode / SKU match (GTIN, SKU or an extra product barcode) — for scanners

Bookings

МетодПутьОбластьЧто делает
GET/api/v1/booking-servicescatalog:readList bookable services (online booking on) (размещённые пространства)
GET/api/v1/booking-services/{id}catalog:readRead a bookable service (размещённые пространства)
GET/api/v1/bookings/slotsbookings:readFree start times of a bookable service on a date (размещённые пространства)
GET/api/v1/bookingsbookings:readList appointments (размещённые пространства)
GET/api/v1/bookings/{id}bookings:readRead an appointment (размещённые пространства)
POST/api/v1/bookingsbookings:writeBook an appointment at a free time (409 when it was taken) (размещённые пространства)

Webhooks

МетодПутьОбластьЧто делает
GET/api/v1/eventswebhooks:readThe webhook event catalog
GET/api/v1/deliverieswebhooks:readWebhook delivery log
GET/api/v1/deliveries/{id}webhooks:readOne delivery with its payload
GET/api/v1/webhookswebhooks:readList webhook endpoints (no secrets) (размещённые пространства)
POST/api/v1/webhookswebhooks:writeCreate a webhook endpoint — the signing secret is returned once (размещённые пространства)
DELETE/api/v1/webhooks/{id}webhooks:writeDelete a webhook endpoint (размещённые пространства)

Account

МетодПутьОбластьЧто делает
GET/api/v1/me(any)Who is calling: the API key, or the person signed in to the app, with the workspace and the scopes

Stock

МетодПутьОбластьЧто делает
GET/api/v1/warehousesstock:readActive stock locations
GET/api/v1/stockstock:readStock levels per location (product=<id> for one product, all its rows)
POST/api/v1/stock/adjustmentsstock:writeAdd or remove stock (same rules as the admin: write-off reasons only remove)

Appointments

МетодПутьОбластьЧто делает
GET/api/v1/appointmentsappointments:readList appointments (from / to filter the start time)
GET/api/v1/appointments/{id}appointments:readRead an appointment

Point of sale

МетодПутьОбластьЧто делает
GET/api/v1/pos-salespos:readList till sales and refunds (since = created since)
GET/api/v1/pos-sales/{id}pos:readRead a till sale with its lines and payments

Tasks

МетодПутьОбластьЧто делает
GET/api/v1/taskstasks:readList tasks (app sign-in without tasks.manage: only my tasks)
GET/api/v1/tasks/{id}tasks:readRead a task
POST/api/v1/taskstasks:writeCreate a task (assigned to the signed-in person by default)
PATCH/api/v1/tasks/{id}tasks:writeUpdate a task or change its status (DONE closes it; recurring tasks schedule the next one)

Files

МетодПутьОбластьЧто делает
POST/api/v1/attachmentsattachments:writeUpload a photo or PDF (multipart: file, taskId?, folder?) — images are re-encoded, metadata such as GPS removed
GET/api/v1/attachments/{id}attachments:writeRead an uploaded file's record

Apps

МетодПутьОбластьЧто делает
POST/api/v1/session/handoff(app)One-time URL (60 s) that signs the app's web view in to the workspace and opens `next` (только токен приложения)
GET/api/v1/devices(app)My app installations (только токен приложения)
POST/api/v1/devices(app)Register an app installation for push (FCM / APNs / Huawei Push Kit token; the same token again returns the same id) (только токен приложения)
DELETE/api/v1/devices/{id}(app)Remove an app installation (только токен приложения)
GET/api/v1/devices/{id}(app)One app installation with the alert categories it does not get pushes for (только токен приложения)
PATCH/api/v1/devices/{id}(app)Alert categories this installation does not get pushes for (tasks, sales, bookings, messages, stock, system) — they still appear in /notifications (только токен приложения)
GET/api/v1/account/deletion(app)Delete account (apps): which path applies — workspace owner closes the workspace, staff ask the administrators, customers use the website — with links and a pending request (только токен приложения)
POST/api/v1/account/deletion(app)Delete account (apps): mode request = ask the administrators to delete the staff account and remove the app data; mode app-data = only end every app sign-in and web session and remove devices / push tokens (только токен приложения)
POST/api/v1/session/sign-out-all(app)Sign out of all devices: ends every app sign-in and web session of the person and removes their app installations (только токен приложения)
GET/api/v1/rider/today(app)Rider mode: which duties I may start (rider = parcels.ride, tech = field.work, driver = fleet.drive), my duty, today's runs, delivery stops and pickups (только токен приложения)
POST/api/v1/rider/duty(app)Start duty (returns a duty token that can only post positions / end the duty) or end it; the workspace's live-location setting must be on (только токен приложения)
POST/api/v1/rider/positions(app)Post a batch of positions while on duty (app token or the duty token fx_dt_…); only the newest valid point is kept (latest position, no trail) and feeds the recipient ETA and the runs map; a driver's batch also moves their vehicle and, when the workspace keeps one, its short trail (только токен приложения)
GET/api/v1/apps(app)Home screen of the apps: the app grid I may open (name, area, icon as SVG nodes, waiting count), the workspace brand and unread alerts (только токен приложения)
GET/api/v1/search(app)Search records I may open (customers, invoices, orders, products …), grouped like the admin header search; also suggestion (did you mean), quick (prefilled create links such as a new invoice for a customer) and intent (только токен приложения)
GET/api/v1/notifications(app)Alerts for me since a time (the desktop app polls this) (только токен приложения)

Sensors

МетодПутьОбластьЧто делает
POST/api/v1/sensors/readingssensors:writeUpload sensor readings (temperature, humidity, fuel_level, value) — up to 500 per request; the device is the key's own device or the serial in `device`; re-sent readings are skipped; send an Idempotency-Key

Далее: Вебхуки

Бизнес-события отправляются на вашу HTTPS-точку: с подписью, повторами и журналом.

Вебхуки