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

Что понадобится

Аккаунт в Doodocs People

Роль администратора тенанта — только она даёт доступ к разделу интеграций.

Developer API-ключ

Настройки → Интеграции → Developer API → Создать ключ. Ключ показывается один раз, сохраните его в менеджере секретов.

Ключ даёт доступ к данным всего тенанта. Не коммитьте его в репозиторий и не используйте во фронтенде.

Проверка ключа

Убедитесь, что ключ принят, прежде чем строить интеграцию.

Первый запрос

curl https://app.doodocs.kz/api/developer/v1/api_key/_verify \
  -H "X-API-Key: ddp_bF49eXwgysLgkZkLDczavSoJ_nx7JYFVQ5Jn2ZEM"

const res = await fetch(
  "https://app.doodocs.kz/api/developer/v1/api_key/_verify",
  { headers: { "X-API-Key": process.env.DOODOCS_API_KEY! } },
);

if (!res.ok) throw new Error(`Ключ отклонён: ${res.status}`);

req, _ := http.NewRequest(http.MethodGet,
    "https://app.doodocs.kz/api/developer/v1/api_key/_verify", nil)
req.Header.Set("X-API-Key", os.Getenv("DOODOCS_API_KEY"))

resp, err := http.DefaultClient.Do(req)
if err != nil {
    return err
}
defer resp.Body.Close()

import os, requests

resp = requests.get(
    "https://app.doodocs.kz/api/developer/v1/api_key/_verify",
    headers={"X-API-Key": os.environ["DOODOCS_API_KEY"]},
)
resp.raise_for_status()

Успешный ответ — пустой JSON-объект со статусом 200:

Ответ

{}

Получили 200 — ключ активен, можно переходить к загрузке данных.

Загрузка сотрудников

Эндпоинт POST /developer/v1/ingest/{source_type} принимает пачку записей из внешней системы. Область ingest:write доступна только ключам супер-администраторов, а заголовок Idempotency-Key обязателен — он защищает от двойной загрузки при повторе запроса.

curl -X POST https://app.doodocs.kz/api/developer/v1/ingest/KEDO \
  -H "X-API-Key: $DOODOCS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-persons-001" \
  -d '{
    "payload_type": "PERSONS",
    "create_missing": true,
    "records": [
      { "external_id": "E-1024", "first_name": "Каныш", "last_name": "Сатпаев", "email": "k.satbayev@example.kz" }
    ]
  }'

Запрос ставится в асинхронную обработку:

{
  "ingest_request_id": "8f4e1c2a-…",
  "status": "ACCEPTED",
  "record_count": 1
}

Источники, типы пейлоадов и полные схемы записей — в справочнике Ingest.

Начало работы

Сотрудники

Документы

Рецепты

Что понадобится

Первый запрос

Загрузка сотрудников

Дальше

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

Ошибки

​Что понадобится

​Первый запрос

​Загрузка сотрудников

​Дальше

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

Ошибки

Что понадобится

Первый запрос

Загрузка сотрудников

Дальше