Hjälp

API för utvecklare

Anslut din programvara genom uttryckliga åtgärder för källor, bearbetning, resultat och administration. Denna guide beskriver det tillgängliga API:t inom de dokumenterade begränsningarna för versionen. Användare, behörigheter, lagring och krediter är fortsatt knutna till Rapportly-kontot.

Förbered integrationen i tre steg

1. 1
   Välj användare, miljö och behörigheter

   Öppna Konto → Integrationer. Använd en testnyckel för simulatorn och en separat produktionsnyckel för riktiga åtgärder med fiktiva data. Administratören tilldelar bara nödvändiga behörigheter och en lämplig budget.

2. 2
   Öva mottagning och fel

   Börja med simulatorn. Importera sedan API-kontrakten och granska de syntetiska exemplen. Hemligheter stannar på servern; ändringar är avstängda som standard i samlingen.

3. 3
   Följ ett helt uppdrag

   Spara indata och uppdragskod, kontrollera start och slutstatus, läs resultatet, ladda ner en tillgänglig fil och kontrollera förbrukningen. Kör övningen först i en godkänd miljö.

Skapa din API-nyckel

Basadress

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

Nyckeln tillhör en användare

En nyckel delegerar en användares behörigheter. Administratören anger miljö, behörighetstak, månadsbudget och slutdatum. Medlemmen aktiverar en förberedd nyckel och ser hemligheten en gång. Varje anrop kontrollerar även aktuella användar-, abonnemangs- och objektbehörigheter. Nyckelhantering använder en användarsession; produktionsåtgärder en API-nyckel. Förvara hemligheter på servern och återkalla förlorade nycklar under Konto → Integrationer. Zapier-händelser har ett eget kontrakt.

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

Använd konkreta kontrakt och exempel

Produktions-OpenAPI beskriver källkontrakt och markerar ofullständiga indata eller svar. Inventeringen visar öppna scheman. Postman-samlingen börjar med ogiltig adress, tomma nycklar och avstängda ändringar. Importera för granskning och skicka medvetet fiktiva data i en godkänd miljö. Importen är ännu inte testad.

• Ladda ner produktions-OpenAPI
• Ladda ner den syntetiska Postman-samlingen
• Ladda ner stegen från källa till nedladdning
• Ladda ner schemainventeringen med öppna delar

Öva först med fiktiva uppdrag

Skapa en testnyckel och öva pågående uppdrag, resultat, fel och otillräcklig budget. Simulatorn använder fasta exempel och kostar inga krediter.

1. Skapa eller aktivera en Test-nyckel under Konto → Integrationer med önskade behörigheter.
2. Hämta GET /test/scenarios och välj en åtgärd från svaret. Listan följer dina aktuella behörigheter.
3. Skicka POST /test/opdrachten med endast actie och scenario: succes, verwerking_mislukt, creditbudget_bereikt eller toegang_geweigerd. Varje ny övning får en egen Idempotency-Key.
4. Spara opdracht_id. Vid bezig läser du GET /test/opdrachten/{id} efter ungefär fem sekunder. Kontrollera alltid status: HTTP200 kan även innehålla ett bearbetningsfel.

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

Exemplet kräver rapport.start i åtgärdslistan. Vid anslutningsfel upprepar du samma data och Idempotency-Key.

• Ladda ner simulatorguiden
• Ladda ner Postman-samlingen för övning
• Ladda ner simulatorns OpenAPI

Hämta bara det du behöver

Sök tillgängliga kundmappar, samtal och rapporter. /acties visar åtgärder och behörigheter, /gebruik budget och reservationer, /verzoeken teknisk historik. Pågående bearbetning har ännu inget resultat. Rapportlänkar gäller i 15 minuter; läs rapporten igen för en ny länk.

Uppdatera kundhanteringen

Din programvara kan ändra kontorsmallar, spara personliga sökningar, registrera ett besök och skapa ett ärendeflöde. Använd rätt administratörsbehörigheter och bekräfta varje ändring. Läs först den aktuella versionen och behåll samma förfrågningsidentifierare om svaret går förlorat. En upprepning av en gammal förfrågan får inte återställa en nyare ändring. Produktionstestet kontrollerar sökningar, besök och ärendeflöden, inklusive städning och återkallande av nycklar. Kontorsmallarna har endast lästs; skrivning har testats lokalt och i CI. Den nedladdningsbara guiden beskriver de fyra rutterna och gränserna för deras bevis.

Jämför två sparade versioner

Jämför två befintliga versionsnummer av samma sparade rapporttextfält eller samtalsfält utan ny AI-bearbetning. Detta kontrakt har testats lokalt och i CI; CRM-testet i produktion bevisar inte jämförelsens beteende i produktion. Saknad historik ersätts inte med den aktuella texten. Långa skillnader kortas till högst 8000 tecken per sida med en tydlig markering. Jämförelsen omfattar inte PowerPoint, offertberäkningar, följebrev eller formatering. Aktuella läsbehörigheter och integritetsvillkor gäller fortfarande.

Begär en kostnadsuppskattning

POST /generatieplan visar förväntade steg och krediter för rapport, offert eller samtalspaket. Använd gebruik:lezen. Beräkning och teaminställningar följer webbplatsen.

Uppskattningen startar ingen bearbetning och drar inga krediter. Den är inget garanterat maxpris. Visa osäkerheter, exempelvis ännu okända kostnader för filläsning. Vid start kontrolleras behörigheter och krediter igen.

Ladda ner uppskattningsguiden med exempel

Starta bearbetning från din programvara

API:t ansluter ärenden, dokument, uppladdningar, ljud, transkribering, kundmappar, stilar, utdata, arbetsflöden, Excel och riktade meddelanden. Varje rutt har egna indata, behörigheter, bekräftelser och versionskontroller. Befintlig bearbetning och kreditredovisning gäller. Ett startsvar bekräftar mottagning; läs därefter status. Inventeringen visar återstående kontrakt.

Skapa först ett ärende

Skapa och spara ett UUID. Skicka PUT /dossiers/{id} med endast naam, högst 200 tecken. 201 betyder skapat, 200 identisk upprepning. Ärendet tillhör nyckelns användare och organisation och kostar inga krediter. Ändrade indata ger 409; otillgängligt eller borttaget ärende ger 404. GET /dossiers/{id} läser naam och klant_id med läsbehörighet.

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, offert eller presentation

Börja med dossierId och notities. tier är valfritt: basis, standaard eller max. Utan stilprofil används neutral formgivning. Du kan ange tillgängliga stijlprofielId, klantId, bronOpnameIds och taal. Stilen måste passa dokumenttypen. Offerter använder företagsinställningar och säker numrering; API:t skickar dem inte till 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"
}

Spara versie_id och följ GET /rapporten/{versie_id}, även för offerter och presentationer. Vid klaar innehåller resultaat tillgängliga filer: export_url för PDF, export_url_docx för Word och export_url_pptx för PowerPoint. Länkar gäller i 15 minuter. Vid mislukt ska bearbetning och förbrukning kontrolleras innan ett nytt uppdrag startas automatiskt med en annan nyckel.

Ladda ner stegen från källa till nedladdning

Ladda upp egna stilexempel

Skicka en till tre exempelfiler som en komplett uppsättning. Rapportly använder samma fil- och stilkontroller som webbplatsen. Lagring och krediter tillhör den anslutna användaren.

1. Skicka filer, namn, dokumenttyp, personligt eller team, uttrycklig bekräftelse och fast uppdragskod. Teamstilar kräver administratör eller teamledare.
2. Spara mottagnings-ID och läs status. Mottaget betyder att hela uppsättningen har sparats; granskning och godkännande kan följa senare.
3. Upprepa exakt samma begäran efter avbrott utan att skapa en andra stil. Ofullständiga uppladdningar kan upprepas i trettio dagar och rensas därefter kontrollerat.

Ladda ner guiden för stilexempel, multipart och fel

Anslut kalender eller brevlåda

Användaren ger själv samtycke hos Google eller Microsoft. Programvaran följer begäran och kan medvetet avsluta anslutningen. Leverantörens lösenord och token finns inte i svaret.

Använd verbindingen:beheren för anslutningar och agenda:lezen för möten. Sändning kräver dessutom sändningsbehörighet och en uttrycklig begäran.

Spara begärans nummer, uppdragskod och aktuell bas. Upprepa förlorade begäranden exakt; en gammal frånkoppling får inte ta bort en senare anslutning.

API:t kan välja standardbrevlåda med administrations- och sändningsbehörighet. Läs först aktuellt val och anslutning. En gammal upprepning ändrar inte ett senare val; befintliga sändningsuppdrag behåller avsändaren.

Ladda ner steg för samtycke, möten, frånkoppling och återställning

Samtalspaket från text

Skicka en transkription med minst hundra tecken. Följ resultatet via gesprek_id. Valfritt: titel, tier, klantId och 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 befintliga språkvarianter

Läs befintliga språkresultat. De beskrivna arbetsflödesrutterna för start, paus, återupptagning och återställning har testats lokalt och i CI; CRM-testet i produktion verifierar inte denna språkbehandling. Använd dem endast i en miljö som har godkänts för detta ändamål. Den ursprungliga användaren, nyckeln, källan och kostnaderna förblir kopplade till förfrågan. Aktuell källstatus, behörigheter, budget och verifierad avräkning krävs fortfarande; en utgången eller raderad källa ger inte rätt till en ny start. Massbearbetning med ett aktiverat andra språk förblir stängd, även med ärvda inställningar. Betald komplettering av ett saknat översättningsresultat är fortfarande utesluten.

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

Få ett meddelande när bearbetningen är klar

Rapportly kan skicka tekniska referenser till din server. Hämta sedan innehållet med rätt läsbehörigheter utan att ständigt fråga efter framsteg.

1. Skapa en HTTPS-mottagare och registrera via POST /webhooks med webhooks:beheren. Använd samma produktionsnyckel för berörda uppdrag.
2. Kontrollera signaturen över ursprungliga meddelandebyte och spara varje händelse-ID unikt. Bekräfta först efter säker lagring tillsammans med nästa uppgift. En upprepning får inte skapa ett andra uppdrag.
3. Läs GET /webhook-afleveringen och leveransdetaljer. Tillfälliga fel provas om högst åtta gånger; en extra omgång kan begäras. Accepterat betyder mottaget av din server. Kontrollera den fortsatta hanteringen där.

• Ladda ner webhookguiden med gränser och återställning
• Ladda ner Node.js-exemplet för signaturkontroll

Simulatorn skickar inga riktiga meddelanden. Prova mottagaren med fiktiva data och separat produktionsanslutning. Exemplet kontrollerar meddelandet; din server sköter lagring och följdåtgärder.

Vad betyder felkoden?

Skydda nyckeln och kunduppgifterna

• Använd nyckeln endast på din server, aldrig i offentlig webbläsarkod.
• Använd en nyckel per integration och återkalla gamla nycklar.
• Lägg inte nycklar, resultat eller tillfälliga länkar i offentliga loggar eller chattar.
• Spara hämtade kunduppgifter enligt ditt systems åtkomstregler.