Hjælp

API til udviklere

Forbind din software gennem udtrykkelige handlinger for kilder, behandling, resultater og administration. Denne vejledning beskriver den tilgængelige API inden for udgivelsens dokumenterede begrænsninger. Bruger, rettigheder, lagerplads og kreditter forbliver knyttet til Rapportly-kontoen.

Forbered integrationen i tre trin

1. 1
   Vælg bruger, miljø og rettigheder

   Åbn Konto → Integrationer. Brug en testnøgle til simulatoren og en separat produktionsnøgle til reelle handlinger med fiktive data. Administratoren tildeler kun nødvendige rettigheder og et passende budget.

2. 2
   Øv modtagelse og fejl

   Start med simulatoren. Importer derefter API-kontrakterne og gennemgå de syntetiske eksempler. Hemmeligheder bliver på serveren; ændringer er som standard slået fra i samlingen.

3. 3
   Følg en hel opgave

   Gem input og opgavekode, kontroller start og slutstatus, læs resultatet, hent en tilgængelig fil og kontroller forbruget. Udfør først prøven i et godkendt miljø.

Opret din API-nøgle

Basisadresse

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

Nøglen tilhører en bruger

En nøgle delegerer en brugers rettigheder. Administratoren angiver miljø, rettighedsloft, månedsbudget og udløb. Medlemmet aktiverer en forberedt nøgle og ser hemmeligheden én gang. Hvert kald kontrollerer også aktuelle bruger-, abonnements- og objektrettigheder. Nøgleadministration bruger en brugersession; produktionshandlinger en API-nøgle. Gem hemmeligheder på serveren, og tilbagekald mistede nøgler under Konto → Integrationer. Zapier-hændelser har deres egen kontrakt.

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

Brug konkrete kontrakter og eksempler

Produktions-OpenAPI beskriver kildekontrakter og markerer delvise input eller svar. Oversigten viser åbne skemaer. Postman-samlingen starter med ugyldig adresse, tomme nøgler og deaktiverede ændringer. Importer til gennemgang, og send bevidst fiktive data i et godkendt miljø. Importen er endnu ikke testet.

• Hent produktions-OpenAPI
• Hent den syntetiske Postman-samling
• Hent trinene fra kilde til download
• Hent skemaoversigten med åbne dele

Øv først med fiktive opgaver

Opret en testnøgle, og øv igangværende opgaver, resultater, fejl og utilstrækkeligt budget. Simulatoren bruger faste eksempler og koster ingen kreditter.

1. Opret eller aktiver en Test-nøgle under Konto → Integrationer med de ønskede rettigheder.
2. Hent GET /test/scenarios, og vælg en handling fra svaret. Listen følger dine aktuelle rettigheder.
3. Send POST /test/opdrachten med kun actie og scenario: succes, verwerking_mislukt, creditbudget_bereikt eller toegang_geweigerd. Hver ny øvelse får sin egen Idempotency-Key.
4. Gem opdracht_id. Ved bezig læser du GET /test/opdrachten/{id} efter cirka fem sekunder. Kontroller altid status: HTTP200 kan også indeholde en behandlingsfejl.

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

Eksemplet kræver rapport.start i handlingslisten. Ved forbindelsesfejl gentages samme input og Idempotency-Key.

• Hent simulatorvejledningen
• Hent Postman-samlingen til øvelser
• Hent simulatorens OpenAPI

Hent kun det nødvendige

Søg i tilgængelige kundemapper, samtaler og rapporter. /acties viser handlinger og rettigheder, /gebruik budget og reservationer, /verzoeken teknisk historik. Igangværende behandling har endnu intet resultat. Rapportlinks gælder i 15 minutter; læs rapporten igen for et nyt link.

Opdater kundeadministrationen

Din software kan ændre kontorskabeloner, gemme personlige søgninger, registrere et besøg og oprette et forløb. Brug de relevante administrationsrettigheder, og bekræft hver ændring. Læs først den aktuelle version, og behold samme anmodningsidentifikator, hvis svaret går tabt. Gentagelse af en gammel anmodning må ikke rulle en nyere ændring tilbage. Produktionstesten kontrollerer søgninger, besøg og opfølgningsforløb, herunder oprydning og tilbagekaldelse af nøgler. Kontorskabeloner blev kun læst; skrivning blev testet lokalt og i CI. Vejledningen til download beskriver de fire ruter og grænserne for deres beviser.

Sammenlign to gemte versioner

Sammenlign to eksisterende versionsnumre af det samme gemte rapporttekstfelt eller samtalefelt uden ny AI-behandling. Denne kontrakt er testet lokalt og i CI; CRM-testen i produktion dokumenterer ikke sammenligningens adfærd i produktion. Manglende historik erstattes ikke af den aktuelle tekst. Lange forskelle afkortes til højst 8000 tegn pr. side med en synlig markering. PowerPoint, tilbudsberegninger, følgebreve og formatering sammenlignes ikke. De aktuelle læserettigheder og privatlivsbetingelser gælder fortsat.

Bed om et prisoverslag

POST /generatieplan viser forventede trin og kreditter for rapport, tilbud eller samtalepakke. Brug gebruik:lezen. Beregning og teamindstillinger følger hjemmesiden.

Overslaget starter ingen behandling og trækker ingen kreditter. Det er ikke en garanteret maksimumpris. Vis usikkerheder, eksempelvis endnu ukendte omkostninger til fillæsning. Ved start kontrolleres rettigheder og kreditter igen.

Hent overslagsvejledningen med eksempler

Start behandling fra din software

API’et forbinder sager, dokumenter, uploads, lyd, transskription, kundemapper, stile, output, workflows, Excel og målrettede beskeder. Hver rute har egne input, rettigheder, bekræftelser og versionskontroller. Eksisterende behandling og kreditafregning gælder fortsat. Et startsvar bekræfter modtagelsen; læs derefter status. Oversigten angiver åbne kontrakter.

Opret først en sag

Opret og gem et UUID. Send PUT /dossiers/{id} med kun naam, højst 200 tegn. 201 betyder oprettet, 200 identisk gentagelse. Sagen tilhører nøglens bruger og organisation og koster ingen kreditter. Ændrede input giver 409; utilgængelig eller slettet sag giver 404. GET /dossiers/{id} læser naam og klant_id med læserettighed.

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

Rapport, tilbud eller præsentation

Start med dossierId og notities. tier er valgfri: basis, standaard eller max. Uden stilprofil bruges neutralt layout. Du kan angive tilgængelige stijlprofielId, klantId, bronOpnameIds og taal. Stilen skal passe til dokumenttypen. Tilbud bruger virksomhedsindstillinger og sikker nummerering; API’et sender dem ikke til kunden.

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

Gem versie_id, og følg GET /rapporten/{versie_id}, også for tilbud og præsentationer. Ved klaar indeholder resultaat tilgængelige filer: export_url til PDF, export_url_docx til Word og export_url_pptx til PowerPoint. Links gælder i 15 minutter. Ved mislukt skal behandling og forbrug kontrolleres, før der automatisk startes en ny opgave med en anden nøgle.

Hent trinene fra kilde til download

Upload dine egne stileksempler

Send en til tre eksempelfiler som et komplet sæt. Rapportly bruger samme fil- og stilkontrol som hjemmesiden. Lagerplads og kreditter tilhører den tilknyttede bruger.

1. Send filer, navn, dokumenttype, personligt eller team, udtrykkelig bekræftelse og fast opgavekode. Teamstile kræver administrator eller teamleder.
2. Gem modtagelses-id, og læs status. Modtaget betyder, at hele sættet er gemt; kontrol af eksempel og godkendelse kan følge senere.
3. Gentag præcis samme anmodning efter afbrydelse uden at oprette en anden stil. Ufuldstændige uploads kan gentages i tredive dage og ryddes derefter kontrolleret op.

Hent vejledningen til stileksempler, multipart og fejl

Forbind kalender eller postkasse

Brugeren giver selv samtykke hos Google eller Microsoft. Softwaren følger anmodningen og kan bevidst afslutte forbindelsen. Udbyderens adgangskoder og tokens findes ikke i svaret.

Brug verbindingen:beheren til forbindelser og agenda:lezen til aftaler. Afsendelse kræver også senderettighed og en udtrykkelig anmodning.

Gem anmodningsnummer, opgavekode og aktuel basis. Gentag mistede anmodninger præcist; en gammel afbrydelse må ikke fjerne en senere forbindelse.

API’et kan vælge standardpostkasse med administrations- og senderettighed. Læs først aktuelle valg og forbindelse. En gammel gentagelse ændrer ikke et senere valg; eksisterende afsendelsesopgaver beholder afsenderen.

Hent trin til samtykke, aftaler, afbrydelse og gendannelse

Samtalepakke fra tekst

Send en transskription på mindst hundrede tegn. Følg resultatet med gesprek_id. Valgfrit: titel, tier, klantId og 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"
}

Læs eksisterende sprogvarianter

Læs eksisterende sprogresultater. De beskrevne arbejdsgangsruter til start, pause, genoptagelse og gendannelse er testet lokalt og i CI; CRM-testen i produktion verificerer ikke denne sprogbehandling. Brug dem kun i et miljø, der er godkendt til formålet. Den oprindelige bruger, nøgle, kilde og omkostninger forbliver knyttet til anmodningen. Aktuel kildestatus, rettigheder, budget og verificeret afregning er fortsat påkrævet; en udløbet eller slettet kilde giver ikke ret til en ny start. Massebehandling med et aktiveret andet sprog forbliver lukket, også med nedarvede indstillinger. Betalt udfyldning af ét manglende oversættelsesresultat er fortsat udelukket.

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

Få besked, når behandlingen er færdig

Rapportly kan sende tekniske referencer til din server. Hent derefter indholdet med de rette læserettigheder uden konstant at spørge om fremdrift.

1. Opret en HTTPS-modtager, og registrer via POST /webhooks med webhooks:beheren. Brug samme produktionsnøgle til de relevante opgaver.
2. Kontroller signaturen på de oprindelige beskedbytes, og gem hvert hændelses-id unikt. Bekræft først efter sikker lagring sammen med den næste opgave. En gentagelse må ikke oprette en anden opgave.
3. Læs GET /webhook-afleveringen og leveringsdetaljerne. Midlertidige fejl prøves igen højst otte gange; en ekstra runde kan anmodes. Accepteret betyder modtaget af din server. Kontroller den videre behandling dér.

• Hent webhookvejledningen med grænser og gendannelse
• Hent Node.js-eksemplet til signaturkontrol

Simulatoren sender ingen rigtige beskeder. Prøv modtageren med fiktive data og separat produktionsforbindelse. Eksemplet kontrollerer beskeden; din server sørger for lagring og opfølgning.

Hvad betyder fejlkoden?

Beskyt nøglen og kundeoplysningerne

• Brug kun nøglen på din server, aldrig i offentlig browserkode.
• Brug en nøgle pr. integration, og tilbagekald gamle nøgler.
• Skriv ikke nøgler, resultater eller midlertidige links i offentlige logfiler eller chats.
• Gem hentede kundeoplysninger efter dit systems adgangsregler.