Hjelp

API for utviklere

Koble programvaren til uttrykkelige handlinger for kilder, behandling, resultater og administrasjon. Denne veiledningen beskriver det tilgjengelige API-et innenfor de dokumenterte begrensningene for utgivelsen. Bruker, rettigheter, lagring og kreditter er fortsatt knyttet til Rapportly-kontoen.

Forbered integrasjonen i tre trinn

1. 1
   Velg bruker, miljø og rettigheter

   Åpne Konto → Integrasjoner. Bruk en testnøkkel til simulatoren og en separat produksjonsnøkkel til virkelige handlinger med fiktive data. Administratoren tildeler bare nødvendige rettigheter og et passende budsjett.

2. 2
   Øv på mottak og feil

   Start med simulatoren. Importer deretter API-kontraktene og vurder de syntetiske eksemplene. Hemmeligheter blir på serveren; endringer er slått av som standard i samlingen.

3. 3
   Følg et helt oppdrag

   Lagre inndata og oppdragskode, kontroller start og sluttstatus, les resultatet, last ned en tilgjengelig fil og kontroller forbruket. Gjør dette først i et godkjent miljø.

Opprett API-nøkkelen din

Basisadresse

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

Nøkkelen tilhører en bruker

En nøkkel delegerer rettighetene til én bruker. Administratoren angir miljø, rettighetstak, månedsbudsjett og utløpsdato. Medlemmet aktiverer en klargjort nøkkel og ser hemmeligheten én gang. Hvert kall kontrollerer også gjeldende bruker-, abonnements- og objektrettigheter. Nøkkeladministrasjon bruker en brukerøkt; produksjonshandlinger en API-nøkkel. Oppbevar hemmeligheter på serveren og tilbakekall tapte nøkler under Konto → Integrasjoner. Zapier-hendelser har sin egen kontrakt.

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

Bruk konkrete kontrakter og eksempler

Produksjons-OpenAPI beskriver kildekontrakter og markerer delvise inndata eller svar. Oversikten viser åpne skjemaer. Postman-samlingen starter med ugyldig adresse, tomme nøkler og deaktiverte endringer. Importer for gjennomgang og send bevisst fiktive data i et godkjent miljø. Importen er ennå ikke testet.

• Last ned produksjons-OpenAPI
• Last ned den syntetiske Postman-samlingen
• Last ned trinnene fra kilde til nedlasting
• Last ned skjemaoversikten med åpne deler

Øv først med fiktive oppdrag

Opprett en testnøkkel og øv pågående oppdrag, resultater, feil og utilstrekkelig budsjett. Simulatoren bruker faste eksempler og koster ingen kreditter.

1. Opprett eller aktiver en Test-nøkkel under Konto → Integrasjoner med ønskede rettigheter.
2. Hent GET /test/scenarios og velg en handling fra svaret. Listen følger dine gjeldende rettigheter.
3. Send POST /test/opdrachten med bare actie og scenario: succes, verwerking_mislukt, creditbudget_bereikt eller toegang_geweigerd. Hver ny øvelse får sin egen Idempotency-Key.
4. Lagre opdracht_id. Ved bezig leser du GET /test/opdrachten/{id} etter omtrent fem sekunder. Kontroller alltid status: HTTP200 kan også inneholde en behandlingsfeil.

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 krever rapport.start i handlingslisten. Ved tilkoblingsfeil gjentas samme inndata og Idempotency-Key.

• Last ned simulatorveiledningen
• Last ned Postman-samlingen for øvelser
• Last ned simulatorens OpenAPI

Hent bare det du trenger

Søk i tilgjengelige kundemapper, samtaler og rapporter. /acties viser handlinger og rettigheter, /gebruik budsjett og reservasjoner, /verzoeken teknisk historikk. Pågående behandling har ennå ikke et resultat. Rapportlenker gjelder i 15 minutter; les rapporten på nytt for en ny lenke.

Oppdater kundeadministrasjonen

Programvaren din kan endre kontormaler, lagre personlige søk, registrere et besøk og opprette et oppfølgingsløp. Bruk de riktige administrasjonsrettighetene og bekreft hver endring. Les først den gjeldende versjonen, og behold samme forespørselsidentifikator hvis svaret går tapt. Gjentakelse av en gammel forespørsel skal ikke tilbakestille en nyere endring. Produksjonstesten kontrollerer søk, besøk og oppfølgingsløp, inkludert opprydding og tilbakekalling av nøkler. Kontormalene ble bare lest; skriving ble testet lokalt og i CI. Den nedlastbare veiledningen beskriver de fire rutene og hva bevisene for dem dekker.

Sammenlign to lagrede versjoner

Sammenlign to eksisterende versjonsnumre av det samme lagrede rapporttekstfeltet eller samtalefeltet uten ny KI-behandling. Denne kontrakten er testet lokalt og i CI; CRM-testen i produksjon dokumenterer ikke sammenligningens virkemåte i produksjon. Manglende historikk erstattes ikke med gjeldende tekst. Lange forskjeller forkortes til maksimalt 8000 tegn per side, med tydelig merking. Sammenligningen omfatter ikke PowerPoint, tilbudsberegninger, følgebrev eller formatering. Gjeldende leserettigheter og personvernvilkår gjelder fortsatt.

Be om et kostnadsoverslag

POST /generatieplan viser forventede trinn og kreditter for rapport, tilbud eller samtalepakke. Bruk gebruik:lezen. Beregning og teaminnstillinger følger nettstedet.

Overslaget starter ingen behandling og trekker ingen kreditter. Det er ingen garantert maksimumspris. Vis usikkerhet, for eksempel ennå ukjente kostnader for fillesing. Ved start kontrolleres rettigheter og kreditter på nytt.

Last ned overslagsveiledningen med eksempler

Start behandling fra programvaren din

API-et kobler saker, dokumenter, opplastinger, lyd, transkripsjon, kundemapper, stiler, utdata, arbeidsflyter, Excel og målrettede meldinger. Hver rute har egne inndata, rettigheter, bekreftelser og versjonskontroller. Eksisterende behandling og kredittavregning gjelder fortsatt. Et startsvar bekrefter mottak; les deretter status. Oversikten viser åpne kontrakter.

Opprett først en sak

Opprett og lagre en UUID. Send PUT /dossiers/{id} med bare naam, maksimalt 200 tegn. 201 betyr opprettet, 200 identisk gjentakelse. Saken tilhører nøkkelens bruker og organisasjon og koster ingen kreditter. Endrede inndata gir 409; utilgjengelig eller slettet sak gir 404. GET /dossiers/{id} leser naam og klant_id med leserettighet.

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 presentasjon

Start med dossierId og notities. tier er valgfritt: basis, standaard eller max. Uten stilprofil brukes nøytral utforming. Du kan angi tilgjengelige stijlprofielId, klantId, bronOpnameIds og taal. Stilen må passe dokumenttypen. Tilbud bruker bedriftsinnstillinger 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"
}

Lagre versie_id og følg GET /rapporten/{versie_id}, også for tilbud og presentasjoner. Ved klaar inneholder resultaat tilgjengelige filer: export_url for PDF, export_url_docx for Word og export_url_pptx for PowerPoint. Lenkene gjelder i 15 minutter. Ved mislukt må behandling og forbruk kontrolleres før et nytt oppdrag startes automatisk med en annen nøkkel.

Last ned trinnene fra kilde til nedlasting

Last opp egne stileksempler

Send én til tre eksempelfiler som et fullstendig sett. Rapportly bruker samme fil- og stilkontroll som nettstedet. Lagring og kreditter tilhører den tilknyttede brukeren.

1. Send filer, navn, dokumenttype, personlig eller team, uttrykkelig bekreftelse og fast oppdragskode. Teamstiler krever administrator eller teamleder.
2. Lagre mottaks-ID og les status. Mottatt betyr at hele settet er lagret; gjennomgang og godkjenning kan komme senere.
3. Gjenta nøyaktig samme forespørsel etter avbrudd uten å opprette en ny stil. Ufullstendige opplastinger kan gjentas i tretti dager og ryddes deretter kontrollert opp.

Last ned veiledningen for stileksempler, multipart og feil

Koble til kalender eller postkasse

Brukeren gir selv samtykke hos Google eller Microsoft. Programvaren følger forespørselen og kan avslutte tilkoblingen bevisst. Leverandørens passord og tokens vises ikke i svaret.

Bruk verbindingen:beheren for tilkoblinger og agenda:lezen for avtaler. Sending krever også senderettighet og en uttrykkelig forespørsel.

Lagre forespørselsnummer, oppdragskode og gjeldende grunnlag. Gjenta tapte forespørsler nøyaktig; en gammel frakobling må ikke fjerne en senere tilkobling.

API-et kan velge standardpostkasse med administrasjons- og senderettighet. Les først gjeldende valg og tilkobling. En gammel gjentakelse endrer ikke et nyere valg; eksisterende sendeoppdrag beholder avsenderen.

Last ned trinn for samtykke, avtaler, frakobling og gjenoppretting

Samtalepakke fra tekst

Send en transkripsjon på minst hundre tegn. Følg resultatet med gesprek_id. Valgfritt: 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"
}

Les eksisterende språkvarianter

Les eksisterende språkresultater. De beskrevne arbeidsflytrutene for start, pause, gjenopptakelse og gjenoppretting er testet lokalt og i CI; CRM-testen i produksjon verifiserer ikke denne språkbehandlingen. Bruk dem bare i et miljø som er godkjent for dette formålet. Den opprinnelige brukeren, nøkkelen, kilden og kostnadene forblir knyttet til forespørselen. Gjeldende kildestatus, rettigheter, budsjett og verifisert avregning er fortsatt påkrevd; en utløpt eller slettet kilde gir ikke tillatelse til en ny start. Massebehandling med et aktivert andrespråk forblir stengt, også med arvede innstillinger. Betalt utfylling av ett manglende oversettelsesresultat er fortsatt utelukket.

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

Få beskjed når behandlingen er ferdig

Rapportly kan sende tekniske referanser til serveren din. Hent deretter innholdet med riktige leserettigheter uten å spørre om fremdrift hele tiden.

1. Opprett en HTTPS-mottaker og registrer via POST /webhooks med webhooks:beheren. Bruk samme produksjonsnøkkel til de aktuelle oppdragene.
2. Kontroller signaturen mot de opprinnelige meldingsbytene og lagre hver hendelses-ID unikt. Bekreft først etter sikker lagring sammen med neste oppgave. En gjentakelse må ikke opprette et nytt oppdrag.
3. Les GET /webhook-afleveringen og leveringsdetaljene. Midlertidige feil forsøkes på nytt maksimalt åtte ganger; en ekstra runde kan bestilles. Akseptert betyr mottatt av serveren din. Kontroller den videre behandlingen der.

• Last ned webhookveiledningen med grenser og gjenoppretting
• Last ned Node.js-eksemplet for signaturkontroll

Simulatoren sender ingen virkelige meldinger. Prøv mottakeren med fiktive data og separat produksjonstilkobling. Eksemplet kontrollerer meldingen; serveren din håndterer lagring og oppfølging.

Hva betyr feilkoden?

Beskytt nøkkelen og kundeopplysningene

• Bruk nøkkelen bare på serveren din, aldri i offentlig nettleserkode.
• Bruk én nøkkel per integrasjon og tilbakekall gamle nøkler.
• Ikke legg nøkler, resultater eller midlertidige lenker i offentlige logger eller samtaler.
• Lagre hentede kundeopplysninger etter tilgangsreglene i systemet ditt.