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

Первый успешный запрос к API распознавания документов за три шага.

API принимает изображение документа и возвращает распознанные поля. Ниже — минимальный сценарий от подключения до первого ответа.

Шаг 1. Получите ключ#

Подключите продукт «Распознавание документов» в личном кабинете и скопируйте API-ключ из карточки продукта. Ключ начинается с dm_. Сразу после подключения доступен пробный лимит — 10 документов.

Шаг 2. Отправьте изображение#

curl

curl -X POST https://devmoon.ru/api/v1/recognize \
  -H "Authorization: Bearer dm_ВАШ_КЛЮЧ" \
  -F "file=@passport.jpg"

Шаг 3. Разберите ответ#

Ответ 200 OK

{
  "documents": [
    {
      "type": "passport_rf",
      "fields": {
        "surname": "ИВАНОВ",
        "name": "ИВАН",
        "patronymic": "ИВАНОВИЧ",
        "series": "4509",
        "number": "123456"
      }
    }
  ],
  "remaining": 9
}

В documents — список найденных на изображении документов, в remaining — остаток лимита после списания.

Пример на Node.js#

recognize.mjs

const form = new FormData()
form.append('file', new Blob([await readFile('passport.jpg')]), 'passport.jpg')

const res = await fetch('https://devmoon.ru/api/v1/recognize', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.DEVMOON_API_KEY}` },
  body: form,
})

if (!res.ok) {
  const { message } = await res.json()
  throw new Error(`${res.status}: ${message}`)
}

const { documents, remaining } = await res.json()