API за разработчици

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. Ръководството за изтегляне описва четирите маршрута и границите на доказателствата за тях.

Сравняване на две запазени версии

Сравни два съществуващи номера на версии на едно и също запазено текстово поле от отчет или поле от разговор без нова AI обработка. Този договор е тестван локално и в 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 и подробностите. Временни грешки се повтарят до осем пъти; може да заявите допълнителен кръг. Прието означава получено от сървъра ви. Проверете последващата обработка там.

• Изтеглете ръководството за webhooks, граници и възстановяване
• Изтеглете Node.js примера за проверка на подписа

Симулаторът не изпраща реални известия. Пробвайте получателя с измислени данни и отделна продукционна връзка. Примерът проверява известието; вашият сървър управлява съхраняването и следващите действия.

Какво означава кодът за грешка?

Защитете ключа и клиентските данни

• Използвайте ключа само на сървъра, никога в публичен код на браузъра.
• Ползвайте отделен ключ за всяка интеграция и отменяйте старите.
• Не слагайте ключове, резултати или временни връзки в публични дневници или чатове.
• Пазете извлечените клиентски данни според правилата за достъп на системата си.