Nyisd meg: Súgó, API fejlesztőknek, és töltsd le az aktuális útmutatót és OpenAPI-leírást.
Hozz létre külön tesztkulcsot, és használd a szintetikus gyakorlókörnyezetet.
Teszteld az állapotot, az eredményt, a hibát és a kerethatárt ügyféladatok nélkül.
Mielőtt éles műveleteket használsz, olvasd el az adott végpont szerződését és kiadási korlátait.
Részletes magyarázat
API fejlesztőknek
Kapcsold össze a szoftveredet a források, feldolgozás, eredmények és kezelés kifejezetten meghatározott műveleteivel. Ez az útmutató a dokumentált kiadási korlátokon belül elérhető API-t ismerteti. A felhasználó, jogosultságok, tárhely és kreditek a Rapportly-fiókhoz kötődnek.
API fejlesztőknek
A meglévő API-alap és a leírt CRM-bővítés ellenőrzött bevezetés után, a kiadás korlátain belül érhető el. A CRM éles környezeti próbája a mentett keresésekre, a látogatások rögzítésére és az ügyfélfolyamatokra terjed ki; az irodai sablonokat csak olvasták. A munkafolyamat nyelvi feldolgozását és az előzmények összehasonlítását helyben és CI-ben tesztelték, de ezek a bizonyítékok nem igazolják teljes éles működésüket. A letölthető útmutató megadja a pontos bizonyítékokat. Ez nem jelent teljes funkcionális egyezést a weboldallal.
Készítsd elő az integrációt három lépésben
1
Válassz felhasználót, környezetet és jogosultságokat
Nyisd meg a Fiók → Integrációk részt. Használj tesztkulcsot a fiktív szimulátorhoz, és külön éles kulcsot a valós műveletekhez fiktív adatokkal. Az adminisztrátor csak a szükséges jogokat és megfelelő keretet adja meg.
2
Gyakorold az átvételt és a hibákat
Kezdj a szimulátorral. Ezután importáld a API-szerződéseket, és tekintsd át a szintetikus példákat. A titkos adatok a szerveren maradnak; a módosítások alapból tiltva vannak a gyűjteményben.
3
Kövess végig egy feladatot
Mentsd a bemenetet és az azonosítót, ellenőrizd az indítást és a végállapotot, olvasd az eredményt, tölts le egy elérhető fájlt, és ellenőrizd a fogyasztást. Csak jóváhagyott környezetben végezd el a próbát.
A kulcs egy felhasználó jogait delegálja. Az adminisztrátor állítja be a környezetet, jogosultsági plafont, havi keretet és lejáratot. A tag aktiválja az előkészített kulcsot, és egyszer látja a titkos értéket. Minden kérés ellenőrzi az aktuális felhasználói, csomag- és objektumjogokat is. A kulcskezelés felhasználói munkamenetet, az éles műveletek API-kulcsot használnak. A titkokat a szerveren tárold; az elveszett kulcsot vond vissza a Fiók → Integrációk alatt. A Zapier-eseményeknek külön szerződésük van.
HTTP
GET https://api.rapportly.io/api/rapportly/v1/ping
Authorization: Bearer rply_<jouw_sleutel>
Használj konkrét szerződéseket és példákat
Az éles OpenAPI leírja a forráskódbeli szerződéseket, és jelöli a részleges bemeneteket vagy válaszokat. A jegyzék mutatja a nyitott sémákat. A Postman-gyűjtemény érvénytelen címmel, üres kulcsokkal és letiltott módosításokkal indul. Importáld áttekintésre, majd tudatosan küldj fiktív adatokat jóváhagyott környezetben. Az import még nincs tesztelve.
Tölts le külső függőségek nélküli, kis méretű klienseket a hozzáférés ellenőrzéséhez, a műveletek és a felhasználás lekérdezéséhez, dossziék létrehozásához, források feltöltéséhez, jelentések, ajánlatok vagy prezentációk indításához, az állapot követéséhez és az eredmények letöltéséhez. Az SDK az API ezen korlátozott részhalmazát támogatja; nem biztosítja a weboldal összes funkcióját. A telepítés és a példák a csomag útmutatójában találhatók.
Az API-kulcsot a saját szervereden tárold, és indítás előtt rögzítsd a kérés azonosságát meghatározó adatokat. A kliensek nem próbálják újra automatikusan a fizetős kéréseket. Az ideiglenes letöltésekhez nem küldenek API-kulcsot, és azok csak az előre engedélyezett tárolási eredetekről (origin) történhetnek. A meglévő jogosultságok, költségkeretek és kiadási korlátok továbbra is érvényesek.
Először fiktív feladatokkal gyakorolj
Hozz létre tesztkulcsot, és próbáld ki a folyamatban lévő feladatokat, eredményeket, hibákat és elégtelen keretet. A szimulátor rögzített példákat használ, és nem kerül kreditbe.
A Fiók → Integrációk alatt hozz létre vagy aktiválj Test-kulcsot a kívánt jogosultságokkal.
Kérd le a GET /test/scenarios útvonalat, és válassz műveletet a válaszból. A lista az aktuális jogaidat követi.
Küldj POST /test/opdrachten kérést csak actie és scenario mezőkkel: succes, verwerking_mislukt, creditbudget_bereikt vagy toegang_geweigerd. Minden új gyakorlat saját Idempotency-Key értéket kap.
Mentsd az opdracht_id értéket. bezig esetén körülbelül öt másodperc után olvasd a GET /test/opdrachten/{id} útvonalat. Mindig ellenőrizd az állapotot: HTTP200 is tartalmazhat sikertelen feldolgozást.
Feladatokat, várakozást, ismétlést és hibákat gyakorolsz. Nem készül valódi fájl, AI-feldolgozás, e-mail vagy webhook. A gyakorlat nem bizonyít dokumentumminőséget vagy valódi kreditelszámolást. Ezután próbálj konkrét éles műveleteket fiktív adatokkal és külön kulccsal. A gyakorlófeladatok hét nap után lejárnak.
Csak a szükséges adatokat kérd le
Keress hozzáférhető ügyfélmappákat, beszélgetéseket és jelentéseket. A /acties mutatja a műveleteket és jogokat, a /gebruik a keretet és foglalásokat, a /verzoeken a technikai előzményeket. Folyamatban lévő feldolgozásnak még nincs eredménye. A jelentéslinkek 15 percig érvényesek; új linkért olvasd újra a jelentést.
GET/ping
Ellenőrizd a kulcsot.
GET/gesprekken?zoek=&limiet=30&offset=0
Keress hozzáférhető beszélgetéseket és lapozd az eredményeket.
GET/gesprekken/{id}
Olvasd a beszélgetés állapotát és eredményét.
GET/rapporten/{id}
Olvasd a jelentés állapotát és eredményét.
GET/rapporten?limiet=30&offset=0
Nézd meg a hozzáférhető jelentéseket, akár egyetlen ügyön belül.
GET/klanten?zoek=&limiet=30&offset=0
Keress hozzáférhető ügyfélmappákat és klantId értékeket.
Ügyfélkezelés frissítése
A szoftvered módosíthatja az irodai sablonokat, mentheti a személyes kereséseket, rögzíthet egy látogatást és létrehozhat egy ügyfélfolyamatot. Használd a megfelelő kezelési jogosultságokat, és erősíts meg minden módosítást. Először olvasd be az aktuális verziót, és válaszvesztés esetén tartsd meg ugyanazt a kérésazonosítót. Egy régi kérés megismétlése nem vonhat vissza egy újabb módosítást. Az éles környezeti próba a kereséseket, a látogatásokat és az ügyfélfolyamatokat ellenőrzi, beleértve a takarítást és a kulcsok visszavonását. Az irodai sablonokat csak olvasták; az írást helyben és CI-ben tesztelték. A letölthető útmutató leírja a négy útvonalat és a hozzájuk tartozó bizonyítékok korlátait.
Két mentett verzió összehasonlítása
Hasonlítsd össze ugyanazon mentett jelentésszöveg-mező vagy beszélgetésmező két meglévő verziószámát új AI-feldolgozás nélkül. Ezt a szerződést helyben és CI-ben tesztelték; a CRM éles környezeti próbája nem igazolja az összehasonlítás éles működését. A hiányzó előzményeket a rendszer nem pótolja az aktuális szöveggel. A hosszú eltéréseket oldalanként legfeljebb 8000 karakterre rövidíti, jól látható jelzéssel. Az összehasonlítás nem terjed ki PowerPoint-fájlokra, árajánlat-számításokra, kísérőlevelekre vagy formázásra. Az aktuális olvasási jogosultságok és adatvédelmi feltételek továbbra is érvényesek.
Kérj előzetes költségbecslést
A POST /generatieplan megmutatja a jelentés, ajánlat vagy beszélgetés várható lépéseit és kreditjeit. Használd a gebruik:lezen jogot. A számítás és csapatbeállítások a webhelyével egyeznek.
A becslés nem indít feldolgozást és nem von le kreditet. Nem garantált felső ár. Mutasd az ismeretlen tényezőket, például a fájlolvasás még ismeretlen költségét. Az indítás újra ellenőrzi a jogokat és krediteket.
Az API összeköti az ügyeket, dokumentumokat, feltöltéseket, hangot, átírást, ügyfélmappákat, stílusokat, kimeneteket, munkafolyamatokat, Excelt és célzott üzeneteket. Minden útvonalnak saját bemenete, jogai, megerősítése és verzióellenőrzése van. A meglévő feldolgozás és kreditelszámolás érvényes. Az indítási válasz az átvételt igazolja; utána olvasd az állapotot. A jegyzék mutatja a nyitott szerződéseket.
Először hozz létre egy ügyet
Generálj és tárolj egy UUID-t. Küldj PUT /dossiers/{id} kérést csak naam mezővel, legfeljebb 200 karakterrel. A 201 létrehozást, a 200 azonos ismétlést jelent. Az ügy a kulcs felhasználójához és szervezetéhez tartozik, és nem kerül kreditbe. Eltérő adat 409-et, elérhetetlen vagy törölt ügy 404-et ad. A GET /dossiers/{id} olvasási joggal lekéri a naam és klant_id mezőket.
Kezdj a dossierId és notities mezőkkel. A tier választható: basis, standaard vagy max. Stílusprofil nélkül semleges megjelenést kapsz. Hozzáférhető stijlprofielId, klantId, bronOpnameIds és taal is megadható. A stílusnak illenie kell a dokumentumtípushoz. Az ajánlat a cégbeállításokat és biztonságos számozást használja; az API nem küldi el az ügyfélnek.
POST/rapporten
Készíts jelentést jegyzetekből és elérhető forrásokból.
POST/offertes
Készíts ajánlatot a meglévő számozással, jogokkal és kreditekkel.
POST/presentaties
Készíts prezentációt, igény szerint presentatieOpties vagy egy hozzáférhető kész jelentés bronRapportVersieId értékével.
HTTP
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"
}
Mentsd a versie_id értéket, és kövesd a GET /rapporten/{versie_id} útvonalat ajánlatoknál és prezentációknál is. klaar állapotban a resultaat tartalmazza az elérhető fájlokat: export_url PDF-hez, export_url_docx Wordhöz, export_url_pptx PowerPointhoz. A linkek 15 percig élnek. mislukt esetén ellenőrizd a feldolgozást és fogyasztást, mielőtt automatikusan új kulccsal indítanál.
Küldj egy–három mintafájlt teljes készletként. A Rapportly a webhellyel azonos fájl- és stílusellenőrzést használja. A tárhely és kreditek a kapcsolt felhasználóhoz tartoznak.
Küldd a fájlokat, nevet, dokumentumtípust, személyes vagy csapathatókört, kifejezett megerősítést és rögzített azonosítót. Csapatstílushoz adminisztrátor vagy csapatvezető kell.
Mentsd az átvételi azonosítót és olvasd az állapotot. Az átvéve a teljes készlet mentését jelenti; az előnézet ellenőrzése és jóváhagyása később következhet.
Megszakítás után pontosan ismételd a kérést második stílus létrehozása nélkül. A hiányos feltöltés harminc napig ismételhető, utána ellenőrzötten törlődik.
A felhasználó személyesen engedélyez a Google-nél vagy Microsoftnál. A szoftver követi a kérést, és tudatosan leállíthatja a kapcsolatot. A szolgáltató jelszavai és tokenjei nem kerülnek a válaszba.
Kapcsolatokhoz verbindingen:beheren, időpontokhoz agenda:lezen kell. Küldéshez külön küldési jog és kifejezett kérés szükséges.
Mentsd a kérés számát, azonosítóját és aktuális alapját. Az elveszett kérést pontosan ismételd; egy régi leválasztás nem törölhet későbbi kapcsolatot.
Az API kezelési és küldési joggal választhat alapértelmezett postafiókot. Előbb olvasd a jelenlegi választást és kapcsolatot. Régi ismétlés nem változtat újabb választáson; a meglévő küldési feladatok megtartják feladójukat.
Küldj legalább száz karakteres átiratot. A gesprek_id segítségével követheted az eredményt. Választható: titel, tier, klantId és taal.
HTTP
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"
}
Meglévő nyelvi változatok olvasása
Olvasd be a meglévő nyelvi eredményeket. Az indításhoz, szüneteltetéshez, folytatáshoz és helyreállításhoz leírt munkafolyamat-útvonalakat helyben és CI-ben tesztelték; a CRM éles környezeti próbája nem igazolja ezt a nyelvi feldolgozást. Kizárólag erre a célra jóváhagyott környezetben használd őket. Az eredeti felhasználó, kulcs, forrás és költségek a kéréshez kötve maradnak. Továbbra is szükséges a forrás aktuális állapota, a jogosultságok, a költségkeret és az ellenőrzött elszámolás; a lejárt vagy törölt forrás nem jogosít új indításra. A bekapcsolt második nyelvvel végzett tömeges feldolgozás továbbra is le van tiltva, örökölt beállítások esetén is. Egyetlen hiányzó fordítási eredmény fizetős pótlása továbbra is ki van zárva.
HTTP
GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>
Kerüld a kettős feladatokat
Minden új feladathoz tárold a pontos bemenetet és egyedi Idempotency-Key értéket. A legtöbb indítás 8–128 biztonságos karaktert fogad el; a hozzájárulás és eredeti jelentésrevíziók legalább 16-ot kérnek. A példák legalább 16-ot használnak. Elveszett válasznál ugyanazokat az adatokat ugyanazzal a kulccsal ismételd. Verzióütközésnél előbb olvass újra. Az ügyek és fájlfeltöltések saját UUID-t használnak ismétlési határként.
Értesítés a feldolgozás befejezésekor
A Rapportly technikai hivatkozásokat küldhet a szerveredre. Ezután megfelelő olvasási jogokkal kérd le a tartalmat, folyamatos állapotlekérdezés nélkül.
Hozz létre HTTPS-fogadót, és regisztráld POST /webhooks kéréssel, webhooks:beheren joggal. Ugyanazt az éles kulcsot használd az érintett feladatokhoz.
Ellenőrizd az aláírást az eredeti üzenetbájtokon, és minden eseményazonosítót egyedileg tárolj. Csak az értesítés és következő feladat biztonságos mentése után igazold vissza. Az ismétlés nem hozhat létre második feladatot.
Olvasd a GET /webhook-afleveringen és kézbesítési részleteit. Az átmeneti hibákat legfeljebb nyolcszor próbálja újra; kérhető egy további kör. Az elfogadva csak a szervered átvételét jelenti. Ellenőrizd ott a további feldolgozást.
A szimulátor nem küld valódi értesítéseket. Próbáld a fogadót fiktív adatokkal és külön éles kapcsolattal. A példa az értesítést ellenőrzi; a szervered intézi a tárolást és további műveleteket.
Mit jelent a hibakód?
400
Javítsd a bemenetet vagy az Idempotency-Key értéket.
401
A kulcs hiányzik, hibás vagy visszavonták.
402
Nincs kredit, keret vagy érvényes fizetős folytatás.
403
A kulcs, felhasználó vagy csomag nem rendelkezik a szükséges joggal.
404
Az objektum hiányzik vagy nem látható a felhasználónak.
409
A bemenet, verzió vagy feladat megváltozott. Előbb olvasd az aktuális állapotot.
429
Várj, és tartsd be a Retry-After értéket.
503
A forrás vagy feldolgozás nem érhető el biztonságosan. Olvasd az állapotot; pontosan ismételni csak az útvonalszerződés engedélyével szabad.
Védd a kulcsot és az ügyféladatokat
Csak a szervereden használd a kulcsot, soha nyilvános böngészőkódban.
Minden integrációhoz külön kulcsot használj, és vond vissza a régieket.
Ne tedd a kulcsokat, eredményeket vagy ideiglenes linkeket nyilvános naplóba vagy csevegésbe.
A lekért ügyféladatokat saját rendszered hozzáférési szabályai szerint tárold.
Mely részek igényelnek még munkát?
A leltár jelzi a részleges sémákat, a letölthető útmutató pedig leírja az egyes műveletek korlátait és bizonyítékait. A sikeres CRM-próba nem igazolja a munkafolyamat nyelvi feldolgozásának vagy az előzmények összehasonlításának éles működését. A többnyelvű tömeges feldolgozás és egyetlen hiányzó fordítási eredmény fizetős pótlása továbbra is kizárt. Az API-kulcs nem ad további felhasználói jogosultságokat; a dokumentum-összehasonlítás csak a leírt mentett szövegmezőket támogatja.
Az, hogy mit látsz, függhet a szerepkörödtől, az előfizetési csomagodtól és a szervezeted kapcsolataitól. Minden elkészült tervezetet ellenőrizz, mielőtt megosztod vagy elküldöd.