Pomocník

API pre vývojárov

Prepojte softvér prostredníctvom výslovných akcií pre zdroje, spracovanie, výsledky a správu. Tento sprievodca opisuje dostupné API v rámci zdokumentovaných obmedzení vydania. Používateľ, oprávnenia, úložisko a kredity zostávajú spojené s účtom Rapportly.

Pripravte prepojenie v troch krokoch

1. 1
   Vyberte používateľa, prostredie a oprávnenia

   Otvorte Účet → Integrácie. Použite testovací kľúč pre fiktívny simulátor a samostatný produkčný kľúč pre skutočné akcie s fiktívnymi údajmi. Správca pridelí iba potrebné oprávnenia a primeraný rozpočet.

2. 2
   Precvičte prijatie a chyby

   Začnite simulátorom. Potom importujte kontrakty API a prezrite syntetické príklady. Tajné údaje zostávajú na serveri; zmeny sú v kolekcii predvolene vypnuté.

3. 3
   Sledujte celú úlohu

   Uložte vstup a kód úlohy, overte spustenie a konečný stav, prečítajte výsledok, stiahnite dostupný súbor a skontrolujte spotrebu. Urobte to až v schválenom prostredí.

Vytvoriť API kľúč

Základná adresa

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

Kľúč patrí používateľovi

Kľúč deleguje oprávnenia jedného používateľa. Správca určí prostredie, strop oprávnení, mesačný rozpočet a platnosť. Člen aktivuje pripravený kľúč a tajnú hodnotu uvidí raz. Každá požiadavka kontroluje aj aktuálne oprávnenia používateľa, balíka a objektu. Správa kľúčov používa používateľskú reláciu; produkčné akcie API kľúč. Uchovávajte tajné údaje na serveri a stratený kľúč zrušte v Účet → Integrácie. Udalosti Zapier majú vlastný kontrakt.

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

Používajte konkrétne kontrakty a príklady

Produkčné OpenAPI opisuje kontrakty kódu a označuje čiastočné vstupy či odpovede. Prehľad ukazuje otvorené schémy. Kolekcia Postman začína neplatnou adresou, prázdnymi kľúčmi a vypnutými zmenami. Importujte na kontrolu a vedome posielajte fiktívne údaje v schválenom prostredí. Import ešte nebol testovaný.

• Stiahnuť špecifikáciu produkčného OpenAPI
• Stiahnuť syntetickú kolekciu Postman
• Stiahnuť postup od zdroja po stiahnutie
• Stiahnuť prehľad schém a otvorených častí

Najprv cvičte s fiktívnymi úlohami

Vytvorte testovací kľúč a precvičte bežiace úlohy, výsledky, chyby a nedostatočný rozpočet. Simulátor používa pevné príklady a nestojí kredity.

1. V Účet → Integrácie vytvorte alebo aktivujte kľúč Test s právami, ktoré chcete precvičiť.
2. Načítajte GET /test/scenarios a vyberte akciu z odpovede. Zoznam rešpektuje aktuálne oprávnenia.
3. Pošlite POST /test/opdrachten iba s actie a scenario: succes, verwerking_mislukt, creditbudget_bereikt alebo toegang_geweigerd. Každé nové cvičenie má vlastný Idempotency-Key.
4. Uložte opdracht_id. Pri bezig načítajte GET /test/opdrachten/{id} približne za päť sekúnd. Vždy kontrolujte stav: HTTP200 môže obsahovať aj zlyhanie spracovania.

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"
}

Príklad vyžaduje rapport.start v zozname akcií. Po chybe spojenia opakujte rovnaké údaje a Idempotency-Key.

• Stiahnuť sprievodcu simulátorom
• Stiahnuť cvičnú kolekciu Postman
• Stiahnuť OpenAPI simulátora

Načítajte iba potrebné údaje

Vyhľadávajte prístupné klientské priečinky, rozhovory a správy. /acties uvádza akcie a oprávnenia, /gebruik rozpočet a rezervácie, /verzoeken technickú históriu. Prebiehajúce spracovanie ešte nemá výsledok. Odkazy na správy platia 15 minút; novým načítaním správy získate nový odkaz.

Aktualizovať správu klientov

Tvoj softvér môže upravovať šablóny kancelárie, ukladať osobné vyhľadávania, zaznamenať návštevu a vytvoriť proces starostlivosti o klienta. Použi príslušné oprávnenia na správu a potvrď každú zmenu. Najprv načítaj aktuálnu verziu a pri strate odpovede zachovaj rovnaký identifikátor požiadavky. Opakovanie starej požiadavky nesmie vrátiť novšiu zmenu. Produkčný test overuje vyhľadávania, návštevy a procesy starostlivosti o klientov vrátane vyčistenia a zrušenia kľúčov. Šablóny kancelárie boli iba čítané; zápis bol otestovaný lokálne a v CI. Príručka na stiahnutie opisuje štyri trasy a hranice dôkazov pre ne.

Porovnať dve uložené verzie

Porovnaj dve existujúce čísla verzií toho istého uloženého textového poľa správy alebo poľa rozhovoru bez nového spracovania pomocou AI. Tento kontrakt bol otestovaný lokálne a v CI; produkčný test CRM nepreukazuje správanie porovnania v produkcii. Chýbajúca história sa nedopĺňa aktuálnym textom. Dlhé rozdiely sa skrátia na najviac 8000 znakov na každej strane s viditeľným upozornením. Neporovnáva sa PowerPoint, výpočty cenových ponúk, sprievodné listy ani formátovanie. Aktuálne oprávnenia na čítanie a podmienky ochrany súkromia naďalej platia.

Vyžiadajte si odhad nákladov

POST /generatieplan ukazuje očakávané kroky a kredity pre správu, ponuku alebo rozhovor. Použite gebruik:lezen. Výpočet a tímové nastavenia zodpovedajú webu.

Odhad nič nespúšťa ani neodpočítava kredity. Nie je zaručenou maximálnou cenou. Uvádzajte neistoty, napríklad dosiaľ neznáme náklady na čítanie súborov. Spustenie znovu kontroluje oprávnenia a kredity.

Stiahnuť sprievodcu odhadom a príklady

Spustite spracovanie zo svojho softvéru

API prepája spisy, dokumenty, nahrávanie, zvuk, prepis, klientské priečinky, štýly, výstupy, pracovné postupy, Excel a cielené správy. Každá cesta má vlastný vstup, oprávnenia, potvrdenia a kontrolu verzie. Existujúce spracovanie a účtovanie kreditov platí ďalej. Odpoveď pri spustení potvrdzuje prijatie; potom čítajte stav. Prehľad označuje otvorené kontrakty.

Najprv vytvorte spis

Vytvorte a uložte UUID. Pošlite PUT /dossiers/{id} iba s naam, najviac 200 znakov. 201 znamená vytvorenie, 200 zhodné opakovanie. Spis patrí používateľovi a organizácii kľúča a nestojí kredity. Odlišné údaje vrátia 409; neprístupný či zmazaný spis 404. GET /dossiers/{id} číta naam a klant_id s oprávnením na čítanie.

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" }

Správa, ponuka alebo prezentácia

Začnite s dossierId a notities. tier je voliteľný: basis, standaard alebo max. Bez štýlového profilu sa použije neutrálny vzhľad. Môžete pridať prístupné stijlprofielId, klantId, bronOpnameIds a taal. Štýl musí zodpovedať typu dokumentu. Ponuky používajú firemné nastavenia a bezpečné číslovanie; API ich neposiela klientovi.

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"
}

Uložte versie_id a sledujte GET /rapporten/{versie_id}, aj pri ponukách a prezentáciách. Pri klaar obsahuje resultaat dostupné súbory: export_url pre PDF, export_url_docx pre Word a export_url_pptx pre PowerPoint. Odkazy platia 15 minút. Pri mislukt najprv overte spracovanie a spotrebu; nespúšťajte automaticky novú úlohu s iným kľúčom.

Stiahnuť postup od zdroja po stiahnutie

Nahrajte vlastné príklady štýlu

Pošlite jeden až tri súbory ako úplnú sadu. Rapportly používa rovnaké kontroly súborov a štýlu ako web. Úložisko a kredity patria pripojenému používateľovi.

1. Pošlite súbory, názov, typ dokumentu, osobný alebo tímový rozsah, výslovné potvrdenie a pevný identifikátor. Tímový štýl vyžaduje správcu alebo vedúceho tímu.
2. Uložte ID prijatia a čítajte stav. Prijaté znamená uloženie celej sady; kontrola náhľadu a schválenie môžu nasledovať.
3. Po prerušení presne opakujte požiadavku bez vytvorenia druhého štýlu. Neúplné nahrávania možno opakovať tridsať dní, potom sa riadene vyčistia.

Stiahnuť sprievodcu príkladmi štýlu, multipart a chybami

Pripojte kalendár alebo schránku

Používateľ osobne udelí súhlas u Google alebo Microsoftu. Softvér sleduje žiadosť a môže spojenie vedome ukončiť. Heslá a tokeny poskytovateľa nie sú v odpovedi.

Použite verbindingen:beheren pre pripojenia a agenda:lezen pre stretnutia. Odosielanie vyžaduje aj právo na odoslanie a výslovnú žiadosť.

Uložte číslo žiadosti, identifikátor a aktuálny základ. Stratené žiadosti opakujte presne; staré odpojenie nesmie odstrániť novšie spojenie.

API môže zvoliť predvolenú schránku s právami na správu a odosielanie. Najprv načítajte aktuálnu voľbu a spojenie. Staré opakovanie nemení novšiu voľbu; existujúce odosielania si zachovajú odosielateľa.

Stiahnuť postup súhlasu, stretnutí, odpojenia a obnovy

Výsledky rozhovoru z textu

Pošlite prepis s najmenej sto znakmi. Výsledok sledujte pomocou gesprek_id. Voliteľné: titel, tier, klantId a 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"
}

Čítanie existujúcich jazykových variantov

Čítaj existujúce jazykové výsledky. Opísané trasy pracovného postupu na spustenie, pozastavenie, pokračovanie a obnovu boli otestované lokálne a v CI; produkčný test CRM toto jazykové spracovanie neoveruje. Používaj ich iba v prostredí schválenom na tento účel. Pôvodný používateľ, kľúč, zdroj a náklady zostávajú viazané na požiadavku. Naďalej sa vyžaduje aktuálny stav zdroja, oprávnenia, rozpočet a overené vyúčtovanie; zdroj s uplynutou platnosťou alebo vymazaný zdroj neoprávňuje na nové spustenie. Hromadné spracovanie so zapnutým druhým jazykom zostáva zablokované, a to aj pri prevzatých nastaveniach. Platené doplnenie jedného chýbajúceho výsledku prekladu je naďalej vylúčené.

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

Získajte oznámenie po dokončení spracovania

Rapportly môže na váš server poslať technické odkazy. Obsah potom načítajte s príslušnými právami na čítanie bez neustálych otázok na priebeh.

1. Vytvorte HTTPS prijímač a zaregistrujte ho cez POST /webhooks s webhooks:beheren. Použite rovnaký produkčný kľúč pre príslušné úlohy.
2. Overte podpis pôvodných bajtov správy a každé ID udalosti uložte jedinečne. Potvrďte až po bezpečnom uložení spolu s nadväzujúcou úlohou. Opakovanie nesmie vytvoriť druhú úlohu.
3. Načítajte GET /webhook-afleveringen a podrobnosti doručenia. Dočasné chyby sa opakujú najviac osemkrát; možno požiadať o ďalšie kolo. Prijaté znamená prijatie vaším serverom. Overte tam ďalšie spracovanie.

• Stiahnuť sprievodcu webhookmi, limitmi a obnovou
• Stiahnuť príklad Node.js na overenie podpisu

Simulátor neposiela skutočné oznámenia. Otestujte prijímač s fiktívnymi údajmi a oddeleným produkčným pripojením. Príklad overuje správu; server zabezpečuje uloženie a ďalšie kroky.

Čo znamená chybový kód?

Chráňte kľúč a klientské údaje

• Používajte kľúč iba na serveri, nikdy vo verejnom kóde prehliadača.
• Pre každé prepojenie použite vlastný kľúč a staré kľúče zrušte.
• Nedávajte kľúče, výsledky ani dočasné odkazy do verejných logov či četov.
• Ukladajte získané klientské údaje podľa prístupových pravidiel svojho systému.