Обзор API

DocMap API предоставляет REST-эндпоинты для извлечения структурированных данных из PDF-документов с помощью шаблонов на базе ИИ.

Базовый URL

Все API-запросы выполняются по адресу:

https://api.docmap.io

Все версионированные эндпоинты имеют префикс /v1/.

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

Все эндпоинты /v1/* требуют заголовок Authorization с Bearer-токеном. Вы можете использовать API-ключ или токен Firebase ID:

Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345

API-ключи можно создавать и управлять ими через Панель управления > Настройки > API-ключи или через эндпоинты API-ключей. Подробности см. в руководстве по аутентификации.

Тип содержимого

Все тела запросов и ответов используют JSON:

Content-Type: application/json

Лимиты запросов

Запросы на извлечение подчиняются ежемесячным лимитам в зависимости от вашего плана. Используйте эндпоинт GET /v1/usage для проверки текущего потребления. См. руководство по лимитам для квот по планам.

Сводка эндпоинтов

Метод	Путь	Описание
GET	/health	Проверка состояния (без аутентификации)
POST	/v1/extractions/run	Запуск извлечения из PDF-документа
GET	/v1/extractions	Список записей извлечений
DELETE	/v1/extractions/{id}	Удаление записи извлечения
GET	/v1/usage	Получение текущего использования за период оплаты
POST	/v1/api-keys	Создание нового API-ключа
GET	/v1/api-keys	Список всех активных API-ключей
DELETE	/v1/api-keys/{id}	Отзыв API-ключа

Проверка состояния

GET /health -- единственный эндпоинт, не требующий аутентификации. Используйте его для проверки доступности API.

curl

curl https://api.docmap.io/health

TypeScript

const res = await fetch('https://api.docmap.io/health')
const data = await res.json()
console.log(data) // { status: "ok" }

Python

import requests

res = requests.get("https://api.docmap.io/health")
print(res.json())  # {"status": "ok"}

Ответ:

{ "status": "ok" }

Формат ошибок

Все ответы об ошибках следуют единой структуре:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key."
  }
}

См. справочник кодов ошибок для полного списка кодов ошибок и их значений.

Спецификация OpenAPI

Полная спецификация OpenAPI доступна для инструментов и генерации клиентов:

• OpenAPI JSON: https://api.docmap.io/openapi.json
• Swagger UI: https://api.docmap.io/docs