Tallker API v1

واجهة الطلبات

واجهة الطلبات. اربط أنظمة الخادم وأرسل جهات الاتصال والطلبات وتعرّف بأمان إلى مستخدمي الأداة.

POST/api/v1/public/ordersscope: orders:write

How it works

1Сформируйте уникальный Idempotency-Key для версии события заказа.
2Передайте заказ и вложенный объект customer.
3При изменении статуса отправьте заказ повторно с новым Idempotency-Key.

أمثلة

curl -X POST https://tallker.com/api/v1/public/orders \
  -H "Authorization: Bearer tk_live_..." -H "Idempotency-Key: order-43829-v1" \
  -H "Content-Type: application/json" \
  -d '{"external_id":"ORDER-43829","status":"new","customer":{"external_id":"CUSTOMER-18452","email":"ivan@example.com"},"amount":5320.50,"currency":"RUB","items":[]}'

Parameters and requirements

external_idобязательноID заказа в вашей системе

statusобязательноnew, processing, paid, shipping, completed или cancelled

customerобязательноКонтакт с external_id и идентифицирующими данными

amount / currencyобязательноСумма ≥ 0 и трёхбуквенный код валюты

items / metadataнеобязательноПозиции заказа и произвольный JSON

Result

{"id":"…","external_id":"ORDER-43829","contact_id":"…","deal_id":"…","status":"new","created":true}

الحدود وعدم التكرار

120 requests / minute · HTTP 429 · Retry-After · Idempotency-Key 24h

الأمان

Чтение: GET /api/v1/public/orders/{external_id}, scope orders:read.

Idempotency-Key хранится 24 часа. Повтор с другим телом вернёт HTTP 409.

OpenAPI 3.1