Chaindoc logoChaindoc

API құжаттамасы

Chaindoc REST API анықтамасы: эндпоинттер, параметрлер, жауап мысалдары және қателер.

Базалық URL

terminal
https://api.chaindoc.io/v1

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

Authorization: Bearer {API_KEY}. Sandbox және Production кілттері бөлек.

Құжаттар

  • POST /documents — жүктеу
  • GET /documents/{id} — алу
  • POST /documents/{id}/fields — өрістерді орналастыру
  • POST /documents/{id}/send — қол қоюды жіберу

Қол қоюшылар

  • Рөлдер: signer, approver, witness, viewer
  • sequence немесе parallel order
  • email немесе link арқылы жеткізу

Webhook оқиғалары

  • document.created, document.completed
  • signature.requested, signature.opened, signature.completed
  • delivery.failed

Қате кодтары

  • 400 — валидация қатесі
  • 401 — жарамсыз кілт
  • 404 — ресурс табылмады
  • 429 — rate limit
  • 500 — ішкі қате