API za razvojne programere

API za razvojne programere

Povežite softver putem izričitih radnji za izvore, obradu, rezultate i upravljanje. Ovaj vodič opisuje dostupan API unutar dokumentiranih ograničenja izdanja. Korisnik, ovlasti, pohrana i krediti ostaju vezani uz račun Rapportly.

Pripremite povezivanje u tri koraka

1. 1
   Odaberite korisnika, okruženje i ovlasti

   Otvorite Račun → Integracije. Upotrijebite testni ključ za izmišljeni simulator i zaseban produkcijski ključ za stvarne radnje s izmišljenim podacima. Administrator dodjeljuje samo potrebne ovlasti i prikladan proračun.

2. 2
   Uvježbajte primitak i pogreške

   Počnite simulatorom. Zatim uvezite API ugovore i pregledajte sintetičke primjere. Tajne ostaju na poslužitelju; izmjene su u zbirci zadano isključene.

3. 3
   Pratite cijeli zadatak

   Spremite ulazne podatke i identifikator, provjerite početak i završno stanje, pročitajte rezultat, preuzmite dostupnu datoteku i provjerite potrošnju. Izvedite ovu probu tek u odobrenom okruženju.

Izradite API ključ

Osnovna adresa

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

Ključ pripada korisniku

Ključ delegira ovlasti jednog korisnika. Administrator određuje okruženje, granicu ovlasti, mjesečni proračun i istek. Član aktivira pripremljeni ključ i vidi tajnu jednom. Svaki zahtjev provjerava i trenutačne ovlasti korisnika, paketa i objekta. Upravljanje ključevima koristi korisničku sesiju; produkcijske radnje API ključ. Čuvajte tajne na poslužitelju i opozovite izgubljeni ključ u Račun → Integracije. Događaji Zapier imaju zaseban ugovor.

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

Koristite konkretne ugovore i primjere

Produkcijski OpenAPI opisuje ugovore koda i označava djelomične ulaze ili odgovore. Popis prikazuje otvorene sheme. Zbirka Postman počinje nevaljanom adresom, praznim ključevima i isključenim izmjenama. Uvezite radi pregleda i svjesno šaljite izmišljene podatke u odobrenom okruženju. Uvoz još nije testiran.

• Preuzmi specifikaciju produkcijskog OpenAPI-ja
• Preuzmi sintetičku zbirku Postman
• Preuzmi put od izvora do preuzimanja
• Preuzmi popis shema i otvorenih dijelova

Najprije vježbajte s izmišljenim zadacima

Izradite testni ključ i uvježbajte zadatke u tijeku, rezultate, pogreške i nedostatan proračun. Simulator koristi stalne primjere i ne troši kredite.

1. U Račun → Integracije izradite ili aktivirajte ključ Test s ovlastima koje želite isprobati.
2. Dohvatite GET /test/scenarios i odaberite radnju iz odgovora. Popis poštuje trenutačne ovlasti.
3. Pošaljite POST /test/opdrachten samo s actie i scenario: succes, verwerking_mislukt, creditbudget_bereikt ili toegang_geweigerd. Svaka nova vježba ima vlastiti Idempotency-Key.
4. Spremite opdracht_id. Pri bezig pročitajte GET /test/opdrachten/{id} nakon približno pet sekundi. Uvijek provjerite stanje: HTTP200 može sadržavati i neuspjelu obradu.

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

Primjer zahtijeva rapport.start na vašem popisu. Nakon problema s vezom ponovite iste podatke i Idempotency-Key.

• Preuzmi vodič simulatora
• Preuzmi zbirku Postman za vježbu
• Preuzmi OpenAPI simulatora

Dohvatite samo potrebne podatke

Pretražite dostupne mape klijenata, razgovore i izvještaje. /acties prikazuje radnje i ovlasti, /gebruik proračun i rezervacije, /verzoeken tehničku povijest. Obrada u tijeku još nema rezultat. Poveznice izvještaja vrijede 15 minuta; ponovno pročitajte izvještaj za novu poveznicu.

Ažuriraj upravljanje klijentima

Tvoj softver može mijenjati predloške ureda, spremati osobna pretraživanja, evidentirati posjet i stvoriti proces praćenja. Koristi odgovarajuće upravljačke ovlasti i potvrdi svaku promjenu. Najprije pročitaj trenutačnu verziju i zadrži isti identifikator zahtjeva ako se odgovor izgubi. Ponavljanje starog zahtjeva ne smije poništiti noviju promjenu. Test u produkciji provjerava pretrage, posjete i procese praćenja, uključujući čišćenje i opoziv ključeva. Predlošci ureda samo su čitani; zapisivanje je testirano lokalno i u CI-ju. Vodič za preuzimanje opisuje četiri rute i granice njihovih dokaza.

Usporedi dvije spremljene verzije

Usporedi dva postojeća broja verzije istog spremljenog tekstnog polja izvještaja ili polja razgovora bez nove obrade umjetnom inteligencijom. Ovaj ugovor testiran je lokalno i u CI-ju; CRM test u produkciji ne dokazuje ponašanje usporedbe u produkciji. Nedostajuća povijest ne nadopunjuje se trenutačnim tekstom. Duge se razlike skraćuju na najviše 8000 znakova po strani uz vidljivu oznaku. Usporedba ne obuhvaća PowerPoint, izračune ponuda, popratna pisma ni oblikovanje. Trenutačne ovlasti za čitanje i uvjeti privatnosti i dalje vrijede.

Zatražite prethodnu procjenu troška

POST /generatieplan prikazuje očekivane korake i kredite za izvještaj, ponudu ili razgovor. Koristite gebruik:lezen. Izračun i postavke tima odgovaraju web-stranici.

Procjena ne pokreće obradu niti troši kredite. Nije zajamčena najveća cijena. Prikažite neizvjesnosti, primjerice još nepoznate troškove čitanja datoteka. Pokretanje ponovno provjerava ovlasti i kredite.

Preuzmi vodič procjene i primjere

Pokrenite obradu iz svojeg softvera

API povezuje predmete, dokumente, učitavanja, zvuk, transkripciju, mape klijenata, stilove, izlaze, tijekove rada, Excel i ciljane poruke. Svaka ruta ima vlastite ulaze, ovlasti, potvrde i provjere verzije. Postojeća obrada i obračun kredita i dalje vrijede. Početni odgovor potvrđuje primitak; zatim pročitajte stanje. Popis navodi nedovršene ugovore.

Najprije izradite predmet

Izradite i spremite UUID. Pošaljite PUT /dossiers/{id} samo s naam, najviše 200 znakova. 201 znači izradu, 200 jednako ponavljanje. Predmet pripada korisniku i organizaciji ključa i ne troši kredite. Drukčiji podaci vraćaju 409; nedostupan ili izbrisan predmet 404. GET /dossiers/{id} čita naam i klant_id uz ovlast čitanja.

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

Izvještaj, ponuda ili prezentacija

Počnite s dossierId i notities. tier nije obvezan: basis, standaard ili max. Bez profila stila koristi se neutralan izgled. Možete dodati dostupne stijlprofielId, klantId, bronOpnameIds i taal. Stil mora odgovarati vrsti dokumenta. Ponude koriste postavke tvrtke i sigurno numeriranje; API ih ne šalje klijentu.

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

Spremite versie_id i pratite GET /rapporten/{versie_id}, također za ponude i prezentacije. U stanju klaar, resultaat sadrži dostupne datoteke: export_url za PDF, export_url_docx za Word i export_url_pptx za PowerPoint. Poveznice vrijede 15 minuta. Pri mislukt najprije provjerite obradu i potrošnju; nemojte automatski pokretati novi zadatak drugim ključem.

Preuzmi put od izvora do preuzimanja

Učitajte vlastite primjere stila

Pošaljite jednu do tri datoteke kao potpuni skup. Rapportly koristi iste provjere datoteka i stila kao web-stranica. Pohrana i krediti pripadaju povezanom korisniku.

1. Pošaljite datoteke, naziv, vrstu dokumenta, osobni ili timski opseg, izričitu potvrdu i stalan identifikator. Timski stil zahtijeva administratora ili voditelja tima.
2. Spremite ID primitka i čitajte stanje. Primljeno znači da je cijeli skup spremljen; provjera pregleda i odobrenje mogu uslijediti.
3. Nakon prekida točno ponovite zahtjev bez stvaranja drugog stila. Nepotpuna učitavanja mogu se ponavljati trideset dana, a zatim se kontrolirano uklanjaju.

Preuzmi vodič primjera stila, multipart učitavanja i pogrešaka

Povežite kalendar ili poštanski sandučić

Korisnik osobno daje privolu Googleu ili Microsoftu. Softver prati zahtjev i može svjesno prekinuti vezu. Lozinke i tokeni pružatelja ne pojavljuju se u odgovoru.

Koristite verbindingen:beheren za veze i agenda:lezen za sastanke. Slanje zahtijeva i ovlast slanja te izričit zahtjev.

Spremite broj zahtjeva, identifikator i trenutačnu osnovu. Izgubljene zahtjeve ponovite točno; stari prekid veze ne smije ukloniti noviju vezu.

API može odabrati zadani sandučić uz ovlasti upravljanja i slanja. Najprije pročitajte trenutačni odabir i vezu. Staro ponavljanje ne mijenja noviji odabir; postojeće pošiljke zadržavaju pošiljatelja.

Preuzmi korake privole, sastanaka, prekida i oporavka

Rezultati razgovora iz teksta

Pošaljite transkript od najmanje sto znakova. Pratite rezultat preko gesprek_id. Neobvezno: titel, tier, klantId i 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"
}

Čitanje postojećih jezičnih inačica

Čitaj postojeće jezične rezultate. Opisane rute tijeka rada za pokretanje, pauziranje, nastavak i oporavak testirane su lokalno i u CI-ju; CRM test u produkciji ne potvrđuje ovu jezičnu obradu. Upotrebljavaj ih samo u okruženju odobrenom za tu svrhu. Izvorni korisnik, ključ, izvor i troškovi ostaju povezani sa zahtjevom. I dalje su potrebni aktualni status izvora, prava, proračun i provjeren obračun; istekli ili izbrisani izvor ne daje pravo na novo pokretanje. Skupna obrada s uključenim drugim jezikom ostaje zatvorena, uključujući naslijeđene postavke. Plaćena nadopuna jednog nedostajućeg rezultata prijevoda i dalje je isključena.

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

Primite obavijest nakon završetka obrade

Rapportly može poslati tehničke reference vašem poslužitelju. Zatim dohvatite sadržaj s odgovarajućim ovlastima čitanja, bez stalnog provjeravanja napretka.

1. Izradite HTTPS primatelja i registrirajte ga putem POST /webhooks uz webhooks:beheren. Koristite isti produkcijski ključ za pripadajuće zadatke.
2. Provjerite potpis izvornih bajtova poruke i svaki ID događaja spremite jedinstveno. Potvrdite tek nakon sigurne pohrane zajedno sa sljedećim zadatkom. Ponavljanje ne smije stvoriti drugi zadatak.
3. Pročitajte GET /webhook-afleveringen i detalje dostave. Privremene pogreške ponavljaju se najviše osam puta; može se zatražiti dodatni krug. Prihvaćeno znači primljeno na vašem poslužitelju. Tamo provjerite daljnju obradu.

• Preuzmi vodič webhookova, ograničenja i oporavka
• Preuzmi Node.js primjer provjere potpisa

Simulator ne šalje stvarne obavijesti. Isprobajte primatelja s izmišljenim podacima i zasebnom produkcijskom vezom. Primjer provjerava obavijest; vaš poslužitelj upravlja pohranom i sljedećim radnjama.

Što znači kod pogreške?

Zaštitite ključ i podatke klijenata

• Koristite ključ samo na poslužitelju, nikad u javnom kodu preglednika.
• Koristite zaseban ključ za svaku integraciju i opozovite stare.
• Ne stavljajte ključeve, rezultate ni privremene poveznice u javne zapisnike ili razgovore.
• Pohranite dohvaćene podatke klijenata prema pravilima pristupa svojeg sustava.