Quickstart

What you’ll need

A Doodocs People account

Super-administrator rights (PERMISSIONS:MANAGE) are what grant access to the integrations section.

A Developer API key

Settings → Integrations → “For developers” → API → Create key. The key is shown once, so store it in a secrets manager.

The key grants access to the whole tenant’s data. Never commit it to a repository or use it in the frontend.

Verify the key

Make sure the key is accepted before building your integration.

First request

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

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(`Key rejected: ${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()

A successful response is an empty JSON object with status 200:

Response

{}

Got a 200 — the key is active, and you can move on to loading data.

Load employees

The POST /developer/v1/ingest/{source_type} endpoint accepts a batch of records from an external system. It requires the ingest:write scope, and the Idempotency-Key header is mandatory: it protects against a double load if the request is retried.

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": "Qanysh", "last_name": "Satbayev", "email": "k.satbayev@example.kz" }
    ]
  }'

The request is queued for asynchronous processing:

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

Sources, payload types, and full record schemas are in the Ingest reference.

Authentication

How to store and rotate keys.

Errors

Error codes and what to do about them.

Getting started

Employees

Documents

Recipes

What you’ll need

First request

Load employees

Next

Authentication

Errors

​What you’ll need

​First request

​Load employees

​Next

Authentication

Errors

What you’ll need

First request

Load employees

Next