Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API improve

  • Добавить раздел Get started.

  • добавить use cases.

  • Привести API method pages к единому шаблону.

  • Добавить object reference для основных сущностей.

Сделать отдельный раздел Examples

У Resend есть отдельная страница Examples, где примеры сгруппированы по фреймворкам и use cases: send email, batch send, attachments, templates, scheduling, webhooks, domains, audiences и т.д.

Для DocStudio аналогично:

Examples

  • Send envelope from template

  • Send envelope with prefilled fields

  • Send envelope with metadata

  • Upload external document

  • Collect e-signature on PDF

  • Sign with QES

  • Download envelope archive

  • Search envelopes in mailbox

  • Create corporate users in bulk

  • Verify and activate account domain

  • Process webhook/callback event

Отдельная страница API token security

У Resend хорошо сделана страница про API key: что это такое, как создать, где хранить, почему нельзя коммитить в репозиторий, как использовать environment variables.

Для DocStudio нужна страница:

Application tokens

Содержимое:

  • What is an application token

  • How to create a token in DocStudio

  • Where to use it

  • How to pass it in requests

  • How to store it safely

  • What not to do

  • How to rotate or delete a token, если функциональность есть

  • Common authentication errors

Priority 1

  1. API overview Что позволяет DocStudio API: envelopes, templates, PDF documents, signatures, mailboxes, users, domains, audit trail.

  2. Authentication / Application tokens Как создать token, как использовать Bearer auth, где хранить token, common auth errors.

  3. Send your first envelope Первый полноценный quickstart.

  4. Core concepts Account, mailbox, template, envelope, recipient, field, metadata, audit trail.

  5. Endpoint page template Привести все method pages к одному формату.

  6. Errors Единый справочник ошибок и troubleshooting.

Priority 2

  1. Object reference

    • Envelope object

    • Template object

    • Mailbox object

    • User object

    • Metadata object

    • Error object

  2. Pagination, filtering, sorting Особенно для mailbox/envelope search.

  3. Webhooks / callbacks Отдельно: events, payload examples, retry behavior, security.

Priority 3

  1. SDK pages

  2. API changelog / versioning

  3. Postman collection

  4. OpenAPI download page

  5. Sandbox/test mode guide

  6. AI-friendly docs / llms.txt visibility

Last updated