Інструкції

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

Підключіть програму через явні дії для джерел, обробки, результатів і керування. Цей посібник описує доступний API у межах задокументованих обмежень випуску. Користувач, права, сховище та кредити залишаються пов’язаними з обліковим записом Rapportly.

Підготуйте інтеграцію за три кроки

1. 1
   Виберіть користувача, середовище та права

   Відкрийте Обліковий запис → Інтеграції. Використовуйте тестовий ключ для симулятора та окремий виробничий ключ для справжніх дій із вигаданими даними. Адміністратор надає лише потрібні права та відповідний бюджет.

2. 2
   Відпрацюйте отримання й помилки

   Почніть із симулятора. Потім імпортуйте контракти API і перегляньте синтетичні приклади. Секрети залишаються на сервері; зміни в колекції вимкнено за замовчуванням.

3. 3
   Простежте повне завдання

   Збережіть вхідні дані й ідентифікатор, перевірте запуск і кінцевий стан, прочитайте результат, завантажте доступний файл та перевірте споживання. Робіть це лише в дозволеному середовищі.

Створіть API-ключ

Базова адреса

https://api.rapportly.io/api/rapportly/v1

Ключ належить користувачеві

Ключ делегує права одного користувача. Адміністратор задає середовище, верхню межу прав, місячний бюджет і строк дії. Учасник активує підготовлений ключ і бачить секрет один раз. Кожен запит також перевіряє поточні права користувача, пакета й об’єкта. Керування ключами використовує сеанс користувача, виробничі дії використовують API-ключ. Зберігайте секрети на сервері й відкликайте загублені ключі в Обліковий запис → Інтеграції. Події Zapier мають окремий контракт.

GET https://api.rapportly.io/api/rapportly/v1/ping
Authorization: Bearer rply_<jouw_sleutel>

Використовуйте конкретні контракти й приклади

Виробничий OpenAPI описує контракти коду й позначає часткові дані або відповіді. Перелік показує відкриті схеми. Колекція Postman починається з недійсної адреси, порожніх ключів і вимкнених змін. Імпортуйте для огляду й свідомо надсилайте вигадані дані в дозволеному середовищі. Імпорт ще не перевірено.

• Завантажити специфікацію виробничого OpenAPI
• Завантажити синтетичну колекцію Postman
• Завантажити шлях від джерела до завантаження
• Завантажити перелік схем і відкритих частин

Спочатку вправляйтеся з вигаданими завданнями

Створіть тестовий ключ і відпрацюйте завдання в процесі, результати, помилки та недостатній бюджет. Симулятор використовує сталі приклади й не витрачає кредитів.

1. В Обліковий запис → Інтеграції створіть або активуйте ключ Test із потрібними правами.
2. Отримайте GET /test/scenarios і виберіть дію з відповіді. Список враховує ваші поточні права.
3. Надішліть POST /test/opdrachten лише з actie і scenario: succes, verwerking_mislukt, creditbudget_bereikt або toegang_geweigerd. Кожна нова вправа має власний Idempotency-Key.
4. Збережіть opdracht_id. За bezig прочитайте GET /test/opdrachten/{id} приблизно через п’ять секунд. Завжди перевіряйте стан: HTTP200 також може містити помилку обробки.

POST https://api.rapportly.io/api/rapportly/v1/test/opdrachten
Authorization: Bearer rply_test_<jouw_testsleutel>
Idempotency-Key: test-rapport-0001
Content-Type: application/json

{
  "actie": "rapport.start",
  "scenario": "succes"
}

Приклад потребує rapport.start у вашому списку. Після збою з’єднання повторіть ті самі дані й Idempotency-Key.

• Завантажити посібник симулятора
• Завантажити навчальну колекцію Postman
• Завантажити OpenAPI симулятора

Отримуйте лише потрібні дані

Шукайте доступні папки клієнтів, розмови та звіти. /acties показує дії й права, /gebruik бюджет і резервування, /verzoeken технічну історію. Незавершена обробка ще не має результату. Посилання звітів діють 15 хвилин; прочитайте звіт знову, щоб отримати нове.

Оновити керування клієнтами

Твоє програмне забезпечення може змінювати шаблони офісу, зберігати особисті пошукові запити, реєструвати відвідування та створювати процес супроводу. Використовуй відповідні права адміністрування й підтверджуй кожну зміну. Спочатку прочитай поточну версію та збережи той самий ідентифікатор запиту, якщо відповідь буде втрачено. Повторення старого запиту не має скасовувати новішу зміну. Перевірка в робочому середовищі охоплює пошуки, відвідування та процеси супроводу, зокрема очищення й відкликання ключів. Шаблони офісу лише прочитано; запис протестовано локально та в CI. Посібник для завантаження описує чотири маршрути й межі доказів для них.

Порівняти дві збережені версії

Порівняй два наявні номери версій того самого збереженого текстового поля звіту або поля розмови без нової обробки ШІ. Цей контракт протестовано локально та в CI; перевірка CRM у робочому середовищі не підтверджує поведінку порівняння в робочому середовищі. Відсутня історія не заповнюється поточним текстом. Довгі відмінності скорочуються до щонайбільше 8000 символів з кожного боку з видимою позначкою. Порівняння не охоплює PowerPoint, розрахунки комерційних пропозицій, супровідні листи чи форматування. Поточні права читання та умови конфіденційності залишаються чинними.

Запросіть попередню оцінку вартості

POST /generatieplan показує очікувані кроки й кредити для звіту, пропозиції або розмови. Використовуйте gebruik:lezen. Розрахунок і налаштування команди відповідають сайту.

Оцінка не запускає обробку й не списує кредити. Це не гарантована максимальна ціна. Показуйте невизначеність, наприклад ще невідомі витрати читання файлів. Запуск повторно перевіряє права й кредити.

Завантажити посібник оцінювання та приклади

Запускайте обробку зі своєї програми

API підключає справи, документи, завантаження, аудіо, транскрипцію, папки клієнтів, стилі, результати, робочі процеси, Excel і цільові повідомлення. Кожен маршрут має власні дані, права, підтвердження та перевірки версій. Чинні обробка й облік кредитів зберігаються. Початкова відповідь підтверджує отримання; потім прочитайте стан. Перелік позначає відкриті контракти.

Спочатку створіть справу

Створіть і збережіть UUID. Надішліть PUT /dossiers/{id} лише з naam, до 200 символів. 201 означає створення, 200 ідентичне повторення. Справа належить користувачеві й організації ключа та не коштує кредитів. Інші дані повертають 409; недоступна або видалена справа 404. GET /dossiers/{id} читає naam і klant_id з правом читання.

PUT https://api.rapportly.io/api/rapportly/v1/dossiers/00000000-0000-4000-8000-000000000002
Authorization: Bearer rply_<jouw_sleutel>
Content-Type: application/json

{ "naam": "Voorbeeldproject" }

Звіт, пропозиція або презентація

Почніть із dossierId і notities. tier необов’язкове: basis, standaard або max. Без профілю стилю застосовується нейтральне оформлення. Можна додати доступні stijlprofielId, klantId, bronOpnameIds і taal. Стиль має відповідати типу документа. Пропозиції використовують налаштування компанії та безпечну нумерацію; API не надсилає їх клієнтові.

POST https://api.rapportly.io/api/rapportly/v1/rapporten
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-rapport-2026-0001
Content-Type: application/json

{
  "dossierId": "00000000-0000-4000-8000-000000000002",
  "notities": "Team Atlas besprak de training. Noor plant de volgende bijeenkomst op donderdag.",
  "tier": "standaard"
}

Збережіть versie_id і стежте за GET /rapporten/{versie_id}, зокрема для пропозицій і презентацій. За klaar об’єкт resultaat містить доступні файли: export_url для PDF, export_url_docx для Word і export_url_pptx для PowerPoint. Посилання діють 15 хвилин. За mislukt перевірте обробку й споживання перед автоматичним новим запуском з іншим ключем.

Завантажити шлях від джерела до завантаження

Завантажте власні приклади стилю

Надішліть від одного до трьох файлів як повний комплект. Rapportly використовує ті самі перевірки файлів і стилю, що й сайт. Сховище та кредити належать підключеному користувачеві.

1. Надішліть файли, назву, тип документа, особистий або командний доступ, явне підтвердження та сталий ідентифікатор. Командний стиль потребує адміністратора або керівника команди.
2. Збережіть ідентифікатор отримання й читайте стан. Отримано означає збереження всього комплекту; перевірка перегляду та схвалення можуть бути пізніше.
3. Після переривання точно повторіть запит, не створюючи другого стилю. Неповні завантаження можна повторювати тридцять днів; потім їх контрольовано очищують.

Завантажити посібник прикладів стилю, multipart і помилок

Підключіть календар або поштову скриньку

Користувач особисто надає згоду в Google або Microsoft. Програма стежить за запитом і може свідомо припинити з’єднання. Паролі й токени постачальника не потрапляють у відповідь.

Використовуйте verbindingen:beheren для з’єднань і agenda:lezen для зустрічей. Надсилання також потребує права надсилання та явного запиту.

Збережіть номер запиту, ідентифікатор і поточну основу. Точно повторюйте втрачені запити; старе відключення не повинно видалити новіше з’єднання.

API може вибрати типову скриньку з правами керування й надсилання. Спершу прочитайте поточний вибір і з’єднання. Старе повторення не змінює новішого вибору; наявні надсилання зберігають відправника.

Завантажити кроки згоди, зустрічей, відключення й відновлення

Результати розмови з тексту

Надішліть транскрипцію щонайменше зі ста символів. Стежте за результатом через gesprek_id. Необов’язкові: titel, tier, klantId і taal.

POST https://api.rapportly.io/api/rapportly/v1/gesprekken
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-gesprek-2026-0001
Content-Type: application/json

{
  "transcript": "Team Atlas bespreekt uitsluitend een fictieve oefening. Het team plant een training en verzamelt algemene voorbeeldvragen zonder klantgegevens.",
  "titel": "Kennismaking"
}

Читання наявних мовних варіантів

Читай наявні мовні результати. Описані маршрути робочого процесу для запуску, призупинення, відновлення та відновлення після збою протестовано локально та в CI; перевірка CRM у робочому середовищі не підтверджує цю мовну обробку. Використовуй їх лише в середовищі, дозволеному для цієї мети. Початковий користувач, ключ, джерело та витрати залишаються пов’язаними із запитом. Актуальний стан джерела, права, бюджет і перевірений розрахунок залишаються обов’язковими; прострочене або видалене джерело не надає права на новий запуск. Пакетна обробка з увімкненою другою мовою залишається закритою, зокрема за успадкованих налаштувань. Платне доповнення одного відсутнього результату перекладу досі виключено.

GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>

Отримайте сповіщення після завершення обробки

Rapportly може надіслати технічні посилання вашому серверу. Потім отримайте вміст із належними правами читання без постійних запитів про прогрес.

1. Створіть HTTPS-приймач і зареєструйте його через POST /webhooks із webhooks:beheren. Використовуйте той самий виробничий ключ для відповідних завдань.
2. Перевірте підпис за початковими байтами повідомлення й зберігайте кожен ідентифікатор події унікально. Підтверджуйте після безпечного збереження разом із наступним завданням. Повторення не має створювати друге завдання.
3. Прочитайте GET /webhook-afleveringen і деталі доставки. Тимчасові помилки повторюються щонайбільше вісім разів; можна запросити додатковий цикл. Прийнято означає отримано вашим сервером. Перевірте подальшу обробку там.

• Завантажити посібник вебхуків, обмежень і відновлення
• Завантажити приклад Node.js для перевірки підпису

Симулятор не надсилає справжніх сповіщень. Випробуйте приймач із вигаданими даними та окремим виробничим підключенням. Приклад перевіряє повідомлення; ваш сервер забезпечує збереження й наступні дії.

Що означає код помилки?

Захищайте ключ і дані клієнтів

• Використовуйте ключ лише на сервері, ніколи в публічному коді браузера.
• Використовуйте окремий ключ для кожної інтеграції та відкликайте старі.
• Не додавайте ключі, результати чи тимчасові посилання до публічних журналів або чатів.
• Зберігайте отримані дані клієнтів за правилами доступу вашої системи.