API

Полный справочник

Каждая установка отдает свое описание OpenAPI со Swagger UI по адресу/swagger/index.html — например,https://reconcio.example.com/swagger/index.html. Оно всегда соответствует вашей версии, поэтому поля запросов и ответов сверяйте с ним. Здесь — главное.

Доступ

Базовый путь — /api/v1. Каждый запрос несет API-ключ в заголовке Authorization:

curl https://reconcio.example.com/api/v1/templates \
  -H "Authorization: Bearer $RECONCIO_API_KEY"

Ключи создаются в кабинете, в разделе API-ключи (см.руководство). Ключ действует от имени создавшего его пользователя и только в пределах своих разрешений:

У ключа также могут быть ограничения частоты запросов в минуту и в сутки и срок действия. Ключи заблокированного пользователя перестают работать сразу.

Методы

Типичный порядок

С шаблоном — один запрос

Загрузите оба файла с template_id. Сверка запустится, как только файлы будут подготовлены, а отчет придет письмом по завершении:

curl -X POST https://reconcio.example.com/api/v1/reconciliations/prepare \
  -H "Authorization: Bearer $RECONCIO_API_KEY" \
  -F file_a=@psp_transactions.csv \
  -F file_b=@ledger.xlsx \
  -F template_id=3c1e7a52-0b9d-4c64-9f0e-2a7d5b8c4e11 \
  -F report_emails=finance@example.com

Или укажите файлы, которые уже лежат в вашем S3:

curl -X POST https://reconcio.example.com/api/v1/reconciliations/prepare-from-storage \
  -H "Authorization: Bearer $RECONCIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file_a": "s3://psp-exports/2026-10/transactions.csv",
    "file_b": "s3://erp-exports/2026-10/ledger.xlsx",
    "template_id": "3c1e7a52-0b9d-4c64-9f0e-2a7d5b8c4e11"
  }'

Результат

В ответе на prepare есть id сверки. Запрашивайте ее, пока status не станет completed илиfailed:

curl https://reconcio.example.com/api/v1/reconciliations/8f2b9d51-f5a8-4b64-8a0d-4c8db2dc6e4f \
  -H "Authorization: Bearer $RECONCIO_API_KEY"

{
  "id": "8f2b9d51-f5a8-4b64-8a0d-4c8db2dc6e4f",
  "status": "completed",
  "file_a_rows_count": 10544,
  "file_b_rows_count": 10531,
  "results": {
    "matched_rows_count": 10487,
    "mismatched_rows_count": 29,
    "missed_rows_count_in_file_b": 26,
    "missed_rows_count_in_file_a": 15,
    "duplicate_key_rows_count": 2,
    "convergence": 0.9934,
    "float_column_stat": [
      {
        "column_name": "amount",
        "total_a": 1284903.17,
        "total_b": 1284903.16,
        "difference": 0.01
      }
    ],
    ...
  }
}

Затем скачайте файл расхождений и отчет:

# Файл расхождений (CSV)
curl -o diff.csv https://reconcio.example.com/api/v1/reconciliations/$ID/diff \
  -H "Authorization: Bearer $RECONCIO_API_KEY"

# PDF-отчет
curl -o report.pdf https://reconcio.example.com/api/v1/reconciliations/$ID/report \
  -H "Authorization: Bearer $RECONCIO_API_KEY"

Без шаблона

Загрузите файлы без template_id, дождитесь статусаawaiting_user_config, посмотрите suggested_columnsи запустите сверку со своим выбором колонок. Подойдет любая колонка файла A или B, не только предложенные; их списки — в file_a_columns иfile_b_columns.

curl -X POST https://reconcio.example.com/api/v1/reconciliations/$ID/run \
  -H "Authorization: Bearer $RECONCIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "final_columns": [
      { "file_a_column": "transaction_id", "file_b_column": "payment_id", "is_join_key": true },
      { "file_a_column": "amount", "file_b_column": "Betrag", "condition": "EQ" },
      { "file_a_column": "status", "file_b_column": "Status", "condition": "IGNORE" }
    ]
  }'

Ошибки

Ошибки возвращаются в формате Problem Details (application/problem+json); точные поля — в Swagger UI.