Nápověda

API pro vývojáře

Propojte software prostřednictvím výslovných akcí pro zdroje, zpracování, výsledky a správu. Tento průvodce popisuje dostupné API v rámci zdokumentovaných omezení vydání. Uživatel, oprávnění, úložiště a kredity zůstávají spojeny s účtem Rapportly.

Připravte propojení ve třech krocích

1. 1
   Vyberte uživatele, prostředí a oprávnění

   Otevřete Účet → Integrace. Použijte testovací klíč pro fiktivní simulátor a samostatný produkční klíč pro skutečné akce s fiktivními daty. Správce přidělí jen potřebná oprávnění a odpovídající rozpočet.

2. 2
   Procvičte přijetí a chyby

   Začněte simulátorem. Potom importujte kontrakty API a prohlédněte syntetické příklady. Tajné údaje zůstávají na serveru; změny jsou v kolekci ve výchozím stavu vypnuté.

3. 3
   Sledujte celou úlohu

   Uložte vstup a kód úlohy, ověřte spuštění a konečný stav, přečtěte výsledek, stáhněte dostupný soubor a zkontrolujte spotřebu. Proveďte to až ve schváleném prostředí.

Vytvořit API klíč

Základní adresa

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

Klíč patří uživateli

Klíč deleguje oprávnění jednoho uživatele. Správce stanoví prostředí, strop oprávnění, měsíční rozpočet a platnost. Člen aktivuje připravený klíč a tajnou hodnotu uvidí jednou. Každý požadavek kontroluje také aktuální oprávnění uživatele, balíčku a objektu. Správa klíčů používá uživatelskou relaci; produkční akce API klíč. Uchovávejte tajné údaje na serveru a ztracený klíč zrušte v Účet → Integrace. Události Zapier mají vlastní kontrakt.

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

Používejte konkrétní kontrakty a příklady

Produkční OpenAPI popisuje kontrakty kódu a označuje částečné vstupy či odpovědi. Přehled ukazuje otevřená schémata. Kolekce Postman začíná neplatnou adresou, prázdnými klíči a vypnutými změnami. Importujte ke kontrole a vědomě posílejte fiktivní data ve schváleném prostředí. Import ještě nebyl testován.

• Stáhnout specifikaci produkčního OpenAPI
• Stáhnout syntetickou kolekci Postman
• Stáhnout postup od zdroje ke stažení
• Stáhnout přehled schémat a otevřených částí

Nejprve cvičte s fiktivními úlohami

Vytvořte testovací klíč a procvičte běžící úlohy, výsledky, chyby a nedostatečný rozpočet. Simulátor používá pevné příklady a nestojí kredity.

1. V Účet → Integrace vytvořte nebo aktivujte klíč Test s právy, která chcete procvičit.
2. Načtěte GET /test/scenarios a vyberte akci z odpovědi. Seznam respektuje aktuální oprávnění.
3. Pošlete POST /test/opdrachten pouze s actie a scenario: succes, verwerking_mislukt, creditbudget_bereikt nebo toegang_geweigerd. Každé nové cvičení má vlastní Idempotency-Key.
4. Uložte opdracht_id. Při bezig načtěte GET /test/opdrachten/{id} přibližně za pět sekund. Vždy kontrolujte stav: HTTP200 může obsahovat i selhání zpracování.

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

Příklad vyžaduje rapport.start v seznamu akcí. Po chybě spojení opakujte stejné údaje a Idempotency-Key.

• Stáhnout průvodce simulátorem
• Stáhnout cvičnou kolekci Postman
• Stáhnout OpenAPI simulátoru

Načítejte jen potřebná data

Vyhledávejte přístupné klientské složky, rozhovory a zprávy. /acties uvádí akce a oprávnění, /gebruik rozpočet a rezervace, /verzoeken technickou historii. Probíhající zpracování ještě nemá výsledek. Odkazy na zprávy platí 15 minut; novým načtením zprávy získáte nový odkaz.

Aktualizovat správu klientů

Tvůj software může upravovat šablony kanceláře, ukládat osobní vyhledávání, zaznamenat návštěvu a vytvořit proces péče o klienta. Použij příslušná oprávnění ke správě a potvrď každou změnu. Nejprve načti aktuální verzi a při ztrátě odpovědi zachovej stejný identifikátor požadavku. Opakování starého požadavku nesmí vrátit novější změnu. Produkční test ověřuje hledání, návštěvy a postupy péče o klienty včetně úklidu a zneplatnění klíčů. Šablony kanceláře byly pouze čteny; zápis byl otestován lokálně a v CI. Průvodce ke stažení popisuje čtyři trasy a meze jejich důkazů.

Porovnat dvě uložené verze

Porovnej dvě existující čísla verzí téhož uloženého textového pole zprávy nebo pole rozhovoru bez nového zpracování pomocí AI. Tento kontrakt byl otestován lokálně a v CI; produkční test CRM neprokazuje chování porovnání v produkci. Chybějící historie se nedoplňuje aktuálním textem. Dlouhé rozdíly se zkrátí na nejvýše 8000 znaků na každé straně s viditelným upozorněním. Neporovnává se PowerPoint, výpočty nabídek, průvodní dopisy ani formátování. Nadále platí aktuální oprávnění ke čtení a podmínky ochrany soukromí.

Vyžádejte si odhad nákladů

POST /generatieplan ukazuje očekávané kroky a kredity pro zprávu, nabídku nebo rozhovor. Použijte gebruik:lezen. Výpočet a týmová nastavení odpovídají webu.

Odhad nic nespouští ani neodečítá kredity. Není zaručenou maximální cenou. Uvádějte nejistoty, například dosud neznámé náklady na čtení souborů. Spuštění znovu kontroluje oprávnění a kredity.

Stáhnout průvodce odhadem a příklady

Spusťte zpracování ze svého softwaru

API propojuje spisy, dokumenty, nahrávání, zvuk, přepis, klientské složky, styly, výstupy, pracovní postupy, Excel a cílené zprávy. Každá cesta má vlastní vstup, oprávnění, potvrzení a kontrolu verze. Stávající zpracování a účtování kreditů platí dál. Odpověď při spuštění potvrzuje přijetí; poté čtěte stav. Přehled označuje otevřené kontrakty.

Nejprve vytvořte spis

Vytvořte a uložte UUID. Pošlete PUT /dossiers/{id} pouze s naam, nejvýše 200 znaků. 201 znamená vytvoření, 200 shodné opakování. Spis patří uživateli a organizaci klíče a nestojí kredity. Odlišné údaje vrátí 409; nepřístupný či smazaný spis 404. GET /dossiers/{id} čte naam a klant_id s oprávněním ke čtení.

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

Zpráva, nabídka nebo prezentace

Začněte s dossierId a notities. tier je volitelný: basis, standaard nebo max. Bez stylového profilu se použije neutrální vzhled. Můžete přidat přístupné stijlprofielId, klantId, bronOpnameIds a taal. Styl musí odpovídat typu dokumentu. Nabídky používají firemní nastavení a bezpečné číslování; API je neposílá 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}, také u nabídek a prezentací. Při klaar obsahuje resultaat dostupné soubory: export_url pro PDF, export_url_docx pro Word a export_url_pptx pro PowerPoint. Odkazy platí 15 minut. Při mislukt nejprve ověřte zpracování a spotřebu; nespouštějte automaticky novou úlohu s jiným klíčem.

Stáhnout postup od zdroje ke stažení

Nahrajte vlastní příklady stylu

Pošlete jeden až tři soubory jako úplnou sadu. Rapportly používá stejné kontroly souborů a stylu jako web. Úložiště a kredity patří připojenému uživateli.

1. Pošlete soubory, název, typ dokumentu, osobní nebo týmový rozsah, výslovné potvrzení a pevný identifikátor. Týmový styl vyžaduje správce nebo vedoucího týmu.
2. Uložte ID přijetí a čtěte stav. Přijato znamená uložení celé sady; kontrola náhledu a schválení mohou následovat.
3. Po přerušení přesně opakujte požadavek bez vytvoření druhého stylu. Neúplná nahrávání lze opakovat třicet dní, poté se řízeně uklidí.

Stáhnout průvodce příklady stylu, multipart a chybami

Připojte kalendář nebo schránku

Uživatel osobně udělí souhlas u Google nebo Microsoftu. Software sleduje žádost a může spojení vědomě ukončit. Hesla a tokeny poskytovatele nejsou v odpovědi.

Použijte verbindingen:beheren pro připojení a agenda:lezen pro schůzky. Odesílání vyžaduje také právo k odeslání a výslovnou žádost.

Uložte číslo žádosti, identifikátor a aktuální základ. Ztracené žádosti opakujte přesně; staré odpojení nesmí odstranit novější spojení.

API může zvolit výchozí schránku s právy ke správě a odesílání. Nejprve načtěte aktuální volbu a spojení. Staré opakování nemění novější volbu; existující odesílání si zachovávají odesílatele.

Stáhnout postup souhlasu, schůzek, odpojení a obnovy

Výsledky rozhovoru z textu

Pošlete přepis alespoň o sto znacích. Výsledek sledujte pomocí gesprek_id. Volitelné: 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"
}

Čtení existujících jazykových variant

Čti existující jazykové výsledky. Popsané trasy pracovního postupu pro spuštění, pozastavení, pokračování a obnovu byly otestovány lokálně a v CI; produkční test CRM toto jazykové zpracování neověřuje. Používej je pouze v prostředí schváleném pro tento účel. Původní uživatel, klíč, zdroj a náklady zůstávají svázané s požadavkem. Nadále je vyžadován aktuální stav zdroje, oprávnění, rozpočet a ověřené vyúčtování; zdroj s vypršenou platností nebo smazaný zdroj neopravňuje k novému spuštění. Hromadné zpracování se zapnutým druhým jazykem zůstává zablokované, a to i při převzatém nastavení. Placené doplnění jednoho chybějícího výsledku překladu je nadále vyloučeno.

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

Získejte oznámení po dokončení zpracování

Rapportly může na váš server poslat technické odkazy. Obsah poté načtěte s příslušnými právy ke čtení, bez neustálých dotazů na průběh.

1. Vytvořte HTTPS přijímač a zaregistrujte jej přes POST /webhooks s webhooks:beheren. Použijte stejný produkční klíč pro příslušné úlohy.
2. Ověřte podpis původních bajtů zprávy a každé ID události uložte jedinečně. Potvrďte až po bezpečném uložení společně s navazující úlohou. Opakování nesmí vytvořit druhou úlohu.
3. Načtěte GET /webhook-afleveringen a podrobnosti doručení. Dočasné chyby se opakují nejvýše osmkrát; lze požádat o další kolo. Přijato znamená přijetí vaším serverem. Ověřte tam další zpracování.

• Stáhnout průvodce webhooky, limity a obnovou
• Stáhnout příklad Node.js pro ověření podpisu

Simulátor neposílá skutečná oznámení. Otestujte přijímač s fiktivními daty a odděleným produkčním připojením. Příklad ověřuje zprávu; server zajišťuje uložení a další kroky.

Co znamená chybový kód?

Chraňte klíč a klientská data

• Používejte klíč jen na serveru, nikdy ve veřejném kódu prohlížeče.
• Pro každé propojení použijte vlastní klíč a staré klíče zrušte.
• Nedávejte klíče, výsledky ani dočasné odkazy do veřejných logů či chatů.
• Ukládejte získaná klientská data podle přístupových pravidel svého systému.