API для розробників

Початок роботи

Усі запити надсилаються на базову URL-адресу та передають ваш ключ як токен Bearer; відповідь завжди у форматі application/json. Для кожного ключа ви визначаєте для кожного ресурсу (форми, заявки), чи може він читати, чи також записувати — права на запис ніколи не надаються автоматично.

Базовий URL

https://app.formuliermet.nl/api/v1

Автентифікація

curl https://app.formuliermet.nl/api/v1/me \
  -H "Authorization: Bearer fmb_je_sleutel_hier"

Створіть ключ у застосунку в розділі Обліковий запис → API & інтеграції. Повний ключ ви побачите лише один раз — зберігайте його в надійному місці. Ключ надає доступ до даних вашого облікового запису; ви можете відкликати його в будь-який момент. Доступ до API входить до складу більших пакетів (див. тарифи).

Ендпоінти

GET

/me

Перевіряє ваш ключ і повертає id вашого облікового запису — зручно для перевірки з'єднання.

GET

/forms

Форми вашого облікового запису (id, назва, slug, активна, кількість заявок). Розбито на сторінки за допомогою ?page та ?limit.

GET

/forms/{id}

Одна форма, включно з визначеннями полів (id, тип, мітка, обов'язкове).

GET

/forms/{id}/submissions

Заявки форми, спочатку найновіші. Розбивайте на сторінки за допомогою ?page та ?limit (макс. 100); отримуйте лише нові за допомогою ?since=<ISO-дата> — ідеально для інтеграцій з опитуванням.

GET

/submissions/{id}

Одна заявка з усіма заповненими полями в data.

POST

/forms

Створює форму. доступ forms:write

PATCH

/forms/{id}

Оновлює форму (назва, поля, налаштування). доступ forms:write

POST

/forms/{id}/publish · /duplicate · /open · /close

Публікує, дублює або відкриває/закриває форму. доступ forms:write

POST

/submissions/{id}/approve · /reject · /note · /reminder

Схвалює або відхиляє, додає внутрішню нотатку або надсилає нагадування про оплату. доступ submissions:write

DELETE

/submissions/{id}

Видаляє заявку разом із завантаженими файлами (фіксується для GDPR). доступ submissions:write

Приклад: отримання заявок

curl "https://app.formuliermet.nl/api/v1/forms/FORM_ID/submissions?limit=2" \
  -H "Authorization: Bearer fmb_je_sleutel_hier"

Відповідь

{
  "data": [
    {
      "id": "ckv8s2...",
      "formId": "ckv7a1...",
      "sequenceNumber": 42,
      "status": "paid",
      "amountCents": 2500,
      "email": "deelnemer@example.com",
      "paymentMethod": "ideal",
      "createdAt": "2026-06-01T14:30:00.000Z",
      "updatedAt": null,
      "data": { "naam": "Jan Jansen", "aantal": 2 }
    }
  ],
  "page": 1,
  "limit": 2,
  "total": 42
}

Вебхуки & події в реальному часі

Хочете, щоб дані надходили саме до вас? Налаштуйте вебхуки для кожної форми: щойно щось відбувається, ми надсилаємо POST-запит із JSON-повідомленням на вашу HTTPS-адресу — або на конектор на кшталт Zapier чи Make. Сповіщення для вашої команди теж можливе, напряму до Slack або Microsoft Teams.

Події, на які можна підписатися

EVENT

submission.created · submission.paid

Отримано нову заявку і завершено оплату.

EVENT

submission.approved

Заявку схвалено в робочому процесі розгляду.

EVENT

ticket.checked_in · waitlist.joined

Квиток відмічено на вході, або реєстрація в списку очікування.

EVENT

subscription.started · subscription.cancelled

Регулярний платіж розпочато або скасовано.

EVENT

form.published

Опубліковано нову версію вашої форми.

Кожне повідомлення підписане за допомогою HMAC-SHA256; у разі збою ми автоматично повторюємо спробу (з поступовим збільшенням інтервалу до кількох годин), а для кожної форми ви бачите журнал доставки. Точний вміст повідомлень (payload), усі заголовки та готовий код перевірки (Node.js & Python) наведені в інтерактивній документації.

→ Інтерактивна документація API · OpenAPI-специфікація (JSON)

Помилки & ліміти

400

Недійсний запит — поле в тілі запиту відсутнє або некоректне.

401

Ключ відсутній, недійсний або відкликаний.

403

Ваш пакет не містить доступу до API (оновіть пакет через тарифи), або вашому ключу бракує потрібного доступу на запис для цієї дії.

404

Не знайдено, або форма/заявка не належить вашому обліковому запису.

409

Конфлікт — наприклад, обрана власна URL-адреса вже використовується.

429

Забагато запитів. Діє досить високий ліміт на ключ на годину.

Кожен ключ бачить виключно дані свого власного облікового запису. Ми ніколи не показуємо через API налаштування вашої форми чи платіжні інтеграції — лише визначення полів і заявки.

Простий REST API

Початок роботи

Ендпоінти

Приклад: отримання заявок

Вебхуки & події в реальному часі

Помилки & ліміти

Бажаєте готову інтеграцію?