Οδηγίες

API για προγραμματιστές

Συνδέστε το λογισμικό με ρητές ενέργειες για πηγές, επεξεργασία, αποτελέσματα και διαχείριση. Αυτός ο οδηγός περιγράφει το διαθέσιμο API εντός των τεκμηριωμένων περιορισμών της έκδοσης. Χρήστης, δικαιώματα, αποθήκευση και πιστώσεις παραμένουν συνδεδεμένα με τον λογαριασμό Rapportly.

Προετοιμάστε την ενσωμάτωση σε τρία βήματα

1. 1
   Επιλέξτε χρήστη, περιβάλλον και δικαιώματα

   Ανοίξτε Λογαριασμός → Ενσωματώσεις. Χρησιμοποιήστε δοκιμαστικό κλειδί για τον προσομοιωτή και ξεχωριστό κλειδί παραγωγής για πραγματικές ενέργειες με εικονικά δεδομένα. Ο διαχειριστής εκχωρεί μόνο τα απαραίτητα δικαιώματα και κατάλληλο όριο δαπάνης.

2. 2
   Εξασκηθείτε στην παραλαβή και στα σφάλματα

   Ξεκινήστε με τον προσομοιωτή. Έπειτα εισαγάγετε τα συμβάσεις API και εξετάστε τα συνθετικά παραδείγματα. Τα μυστικά παραμένουν στον διακομιστή· οι αλλαγές είναι απενεργοποιημένες από προεπιλογή στη συλλογή.

3. 3
   Παρακολουθήστε μια πλήρη εργασία

   Αποθηκεύστε είσοδο και αναγνωριστικό, ελέγξτε έναρξη και τελική κατάσταση, διαβάστε το αποτέλεσμα, κατεβάστε διαθέσιμο αρχείο και ελέγξτε την κατανάλωση. Εκτελέστε τη δοκιμή μόνο σε εγκεκριμένο περιβάλλον.

Δημιουργήστε κλειδί API

Βασική διεύθυνση

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

Το κλειδί ανήκει σε χρήστη

Το κλειδί μεταβιβάζει δικαιώματα ενός χρήστη. Ο διαχειριστής ορίζει περιβάλλον, ανώτατα δικαιώματα, μηνιαίο όριο και λήξη. Το μέλος ενεργοποιεί το προετοιμασμένο κλειδί και βλέπει το μυστικό μία φορά. Κάθε αίτημα ελέγχει επίσης τα τρέχοντα δικαιώματα χρήστη, πακέτου και αντικειμένου. Η διαχείριση κλειδιών χρησιμοποιεί συνεδρία χρήστη και οι ενέργειες παραγωγής κλειδί API. Φυλάξτε τα μυστικά στον διακομιστή και ανακαλέστε χαμένο κλειδί από Λογαριασμός → Ενσωματώσεις. Τα συμβάντα Zapier έχουν δική τους σύμβαση.

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

Χρησιμοποιήστε συγκεκριμένες συμβάσεις και παραδείγματα

Το OpenAPI παραγωγής περιγράφει συμβάσεις κώδικα και σημειώνει μερικές εισόδους ή απαντήσεις. Ο κατάλογος δείχνει ανοιχτά σχήματα. Η συλλογή Postman ξεκινά με άκυρη διεύθυνση, κενά κλειδιά και απενεργοποιημένες αλλαγές. Εισαγάγετε για έλεγχο και στείλτε συνειδητά εικονικά δεδομένα σε εγκεκριμένο περιβάλλον. Η εισαγωγή δεν έχει ακόμη δοκιμαστεί.

• Κατεβάστε το προδιαγραφή OpenAPI παραγωγής
• Κατεβάστε τη συνθετική συλλογή Postman
• Κατεβάστε τη διαδρομή από πηγή έως λήψη
• Κατεβάστε τον κατάλογο σχημάτων και ανοιχτών μερών

Εξασκηθείτε πρώτα με εικονικές εργασίες

Δημιουργήστε δοκιμαστικό κλειδί και δοκιμάστε εργασίες σε εξέλιξη, αποτελέσματα, σφάλματα και ανεπαρκές όριο. Ο προσομοιωτής χρησιμοποιεί σταθερά παραδείγματα χωρίς χρέωση πιστώσεων.

1. Στο Λογαριασμός → Ενσωματώσεις δημιουργήστε ή ενεργοποιήστε κλειδί Test με τα επιθυμητά δικαιώματα.
2. Ζητήστε GET /test/scenarios και επιλέξτε ενέργεια από την απάντηση. Η λίστα ακολουθεί τα τρέχοντα δικαιώματα.
3. Στείλτε POST /test/opdrachten μόνο με actie και scenario: succes, verwerking_mislukt, creditbudget_bereikt ή toegang_geweigerd. Κάθε νέα άσκηση έχει δικό της Idempotency-Key.
4. Αποθηκεύστε opdracht_id. Στο bezig διαβάστε GET /test/opdrachten/{id} μετά από περίπου πέντε δευτερόλεπτα. Ελέγχετε πάντα την κατάσταση: το HTTP200 μπορεί να περιέχει αποτυχία επεξεργασίας.

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

Το παράδειγμα απαιτεί rapport.start στη λίστα σας. Μετά από πρόβλημα σύνδεσης επαναλάβετε τα ίδια δεδομένα και Idempotency-Key.

• Κατεβάστε τον οδηγό προσομοιωτή
• Κατεβάστε τη συλλογή εξάσκησης Postman
• Κατεβάστε το OpenAPI του προσομοιωτή

Ανακτήστε μόνο όσα χρειάζεστε

Αναζητήστε προσβάσιμους φακέλους πελατών, συνομιλίες και αναφορές. Το /acties δείχνει ενέργειες και δικαιώματα, το /gebruik όρια και δεσμεύσεις, το /verzoeken τεχνικό ιστορικό. Η επεξεργασία σε εξέλιξη δεν έχει ακόμη αποτέλεσμα. Οι σύνδεσμοι αναφορών ισχύουν 15 λεπτά· διαβάστε ξανά την αναφορά για νέο σύνδεσμο.

Ενημέρωση διαχείρισης πελατών

Το λογισμικό σου μπορεί να τροποποιεί πρότυπα γραφείου, να αποθηκεύει προσωπικές αναζητήσεις, να καταγράφει μια επίσκεψη και να δημιουργεί μια διαδικασία παρακολούθησης. Χρησιμοποίησε τα κατάλληλα δικαιώματα διαχείρισης και επιβεβαίωσε κάθε αλλαγή. Διάβασε πρώτα την τρέχουσα έκδοση και διατήρησε το ίδιο αναγνωριστικό αιτήματος αν χαθεί η απάντηση. Η επανάληψη ενός παλιού αιτήματος δεν πρέπει να αναιρεί μια νεότερη αλλαγή. Η δοκιμή στην παραγωγή ελέγχει αναζητήσεις, επισκέψεις και διαδικασίες παρακολούθησης, μαζί με την εκκαθάριση και την ανάκληση κλειδιών. Τα πρότυπα γραφείου μόνο διαβάστηκαν· η εγγραφή δοκιμάστηκε τοπικά και στο CI. Ο οδηγός λήψης περιγράφει τις τέσσερις διαδρομές και τα όρια των αποδεικτικών στοιχείων τους.

Σύγκριση δύο αποθηκευμένων εκδόσεων

Σύγκρινε δύο υπάρχοντες αριθμούς έκδοσης του ίδιου αποθηκευμένου πεδίου κειμένου αναφοράς ή πεδίου συνομιλίας χωρίς νέα επεξεργασία με AI. Αυτή η σύμβαση δοκιμάστηκε τοπικά και στο CI· η δοκιμή CRM στην παραγωγή δεν αποδεικνύει τη συμπεριφορά της σύγκρισης στην παραγωγή. Το ιστορικό που λείπει δεν συμπληρώνεται με το τρέχον κείμενο. Οι μεγάλες διαφορές περικόπτονται σε έως 8000 χαρακτήρες ανά πλευρά με εμφανή ένδειξη. Δεν συγκρίνονται PowerPoint, υπολογισμοί προσφορών, συνοδευτικές επιστολές ή μορφοποίηση. Τα ισχύοντα δικαιώματα ανάγνωσης και οι όροι απορρήτου εξακολουθούν να εφαρμόζονται.

Ζητήστε εκτίμηση κόστους εκ των προτέρων

Το POST /generatieplan δείχνει αναμενόμενα βήματα και πιστώσεις για αναφορά, προσφορά ή συνομιλία. Χρησιμοποιήστε gebruik:lezen. Υπολογισμός και ομαδικές ρυθμίσεις ακολουθούν τον ιστότοπο.

Η εκτίμηση δεν ξεκινά επεξεργασία ούτε αφαιρεί πιστώσεις. Δεν είναι εγγυημένη μέγιστη τιμή. Δείξτε αβεβαιότητες, όπως άγνωστο ακόμη κόστος ανάγνωσης αρχείων. Η έναρξη ελέγχει ξανά δικαιώματα και πιστώσεις.

Κατεβάστε τον οδηγό εκτίμησης και παραδείγματα

Ξεκινήστε επεξεργασία από το λογισμικό σας

Το API συνδέει υποθέσεις, έγγραφα, μεταφορτώσεις, ήχο, απομαγνητοφώνηση, φακέλους πελατών, στυλ, εξόδους, ροές εργασίας, Excel και στοχευμένα μηνύματα. Κάθε διαδρομή έχει δικές της εισόδους, δικαιώματα, επιβεβαιώσεις και ελέγχους έκδοσης. Ισχύουν η υπάρχουσα επεξεργασία και χρέωση πιστώσεων. Η αρχική απάντηση επιβεβαιώνει παραλαβή· έπειτα διαβάστε την κατάσταση. Ο κατάλογος δείχνει τις ανοιχτές συμβάσεις.

Δημιουργήστε πρώτα φάκελο υπόθεσης

Δημιουργήστε και αποθηκεύστε UUID. Στείλτε PUT /dossiers/{id} μόνο με naam, έως 200 χαρακτήρες. Το 201 σημαίνει δημιουργία και το 200 ίδια επανάληψη. Ο φάκελος ανήκει στον χρήστη και στον οργανισμό του κλειδιού και δεν κοστίζει πιστώσεις. Διαφορετική είσοδος δίνει 409, μη προσβάσιμος ή διαγραμμένος φάκελος 404. Το GET /dossiers/{id} διαβάζει naam και klant_id με δικαίωμα ανάγνωσης.

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

Αναφορά, προσφορά ή παρουσίαση

Ξεκινήστε με dossierId και notities. Το tier είναι προαιρετικό: basis, standaard ή max. Χωρίς προφίλ στυλ χρησιμοποιείται ουδέτερη εμφάνιση. Μπορείτε να προσθέσετε προσβάσιμα stijlprofielId, klantId, bronOpnameIds και taal. Το στυλ πρέπει να ταιριάζει στον τύπο εγγράφου. Οι προσφορές χρησιμοποιούν εταιρικές ρυθμίσεις και ασφαλή αρίθμηση· το API δεν τις στέλνει στον πελάτη.

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

Αποθηκεύστε versie_id και παρακολουθήστε GET /rapporten/{versie_id}, και για προσφορές ή παρουσιάσεις. Στο klaar, το resultaat περιέχει διαθέσιμα αρχεία: export_url για PDF, export_url_docx για Word και export_url_pptx για PowerPoint. Οι σύνδεσμοι διαρκούν 15 λεπτά. Στο mislukt ελέγξτε επεξεργασία και κατανάλωση πριν από αυτόματη νέα έναρξη με άλλο κλειδί.

Κατεβάστε τη διαδρομή από πηγή έως λήψη

Μεταφορτώστε δικά σας παραδείγματα στυλ

Στείλτε ένα έως τρία αρχεία ως πλήρες σύνολο. Το Rapportly χρησιμοποιεί τους ίδιους ελέγχους αρχείων και στυλ με τον ιστότοπο. Αποθήκευση και πιστώσεις ανήκουν στον συνδεδεμένο χρήστη.

1. Στείλτε αρχεία, όνομα, τύπο εγγράφου, προσωπικό ή ομαδικό πεδίο, ρητή επιβεβαίωση και σταθερό αναγνωριστικό. Το ομαδικό στυλ απαιτεί διαχειριστή ή υπεύθυνο ομάδας.
2. Αποθηκεύστε το αναγνωριστικό παραλαβής και διαβάστε την κατάσταση. Παραλήφθηκε σημαίνει αποθήκευση όλου του συνόλου· έλεγχος προεπισκόπησης και έγκριση μπορεί να ακολουθήσουν.
3. Μετά από διακοπή επαναλάβετε ακριβώς το αίτημα χωρίς δεύτερο στυλ. Ελλιπείς μεταφορτώσεις επαναλαμβάνονται για τριάντα ημέρες και μετά καθαρίζονται ελεγχόμενα.

Κατεβάστε τον οδηγό παραδειγμάτων στυλ, multipart και σφαλμάτων

Συνδέστε ημερολόγιο ή γραμματοκιβώτιο

Ο χρήστης δίνει ο ίδιος συγκατάθεση στη Google ή στη Microsoft. Το λογισμικό παρακολουθεί το αίτημα και μπορεί να διακόψει συνειδητά τη σύνδεση. Κωδικοί και διακριτικά του παρόχου δεν εμφανίζονται στην απάντηση.

Χρησιμοποιήστε verbindingen:beheren για συνδέσεις και agenda:lezen για ραντεβού. Η αποστολή απαιτεί επιπλέον δικαίωμα αποστολής και ρητό αίτημα.

Αποθηκεύστε αριθμό αιτήματος, αναγνωριστικό και τρέχουσα βάση. Επαναλάβετε χαμένα αιτήματα ακριβώς· παλιά αποσύνδεση δεν πρέπει να αφαιρεί νεότερη σύνδεση.

Το API μπορεί να επιλέξει προεπιλεγμένο γραμματοκιβώτιο με δικαιώματα διαχείρισης και αποστολής. Διαβάστε πρώτα τρέχουσα επιλογή και σύνδεση. Παλιά επανάληψη δεν αλλάζει νεότερη επιλογή· υπάρχουσες αποστολές διατηρούν αποστολέα.

Κατεβάστε βήματα συγκατάθεσης, ραντεβού, αποσύνδεσης και αποκατάστασης

Αποτελέσματα συνομιλίας από κείμενο

Στείλτε απομαγνητοφώνηση τουλάχιστον εκατό χαρακτήρων. Παρακολουθήστε το αποτέλεσμα με gesprek_id. Προαιρετικά: titel, tier, klantId και 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"
}

Ανάγνωση υπαρχουσών γλωσσικών παραλλαγών

Διάβασε υπάρχοντα γλωσσικά αποτελέσματα. Οι περιγραφόμενες διαδρομές ροής εργασίας για έναρξη, παύση, συνέχιση και αποκατάσταση δοκιμάστηκαν τοπικά και στο CI· η δοκιμή CRM στην παραγωγή δεν επαληθεύει αυτή τη γλωσσική επεξεργασία. Χρησιμοποίησέ τες μόνο σε περιβάλλον εγκεκριμένο για αυτόν τον σκοπό. Ο αρχικός χρήστης, το κλειδί, η πηγή και το κόστος παραμένουν συνδεδεμένα με το αίτημα. Η τρέχουσα κατάσταση της πηγής, τα δικαιώματα, ο προϋπολογισμός και η επαληθευμένη εκκαθάριση χρεώσεων παραμένουν απαραίτητα· μια ληγμένη ή διαγραμμένη πηγή δεν παρέχει δικαίωμα νέας έναρξης. Η μαζική επεξεργασία με ενεργοποιημένη δεύτερη γλώσσα παραμένει κλειστή, ακόμη και με κληρονομημένες ρυθμίσεις. Η επί πληρωμή συμπλήρωση ενός ελλείποντος αποτελέσματος μετάφρασης εξακολουθεί να αποκλείεται.

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

Λάβετε ειδοποίηση όταν ολοκληρωθεί η επεξεργασία

Το Rapportly μπορεί να στείλει τεχνικές αναφορές στον διακομιστή σας. Ανακτήστε μετά το περιεχόμενο με κατάλληλα δικαιώματα χωρίς συνεχείς ερωτήσεις προόδου.

1. Δημιουργήστε δέκτη HTTPS και καταχωρίστε τον μέσω POST /webhooks με webhooks:beheren. Χρησιμοποιήστε το ίδιο κλειδί παραγωγής για τις σχετικές εργασίες.
2. Επαληθεύστε την υπογραφή στα αρχικά bytes και αποθηκεύστε κάθε αναγνωριστικό συμβάντος μοναδικά. Επιβεβαιώστε μετά την ασφαλή αποθήκευση μαζί με την επόμενη εργασία. Μια επανάληψη δεν πρέπει να δημιουργεί δεύτερη εργασία.
3. Διαβάστε GET /webhook-afleveringen και λεπτομέρειες παράδοσης. Τα προσωρινά σφάλματα επαναλαμβάνονται έως οκτώ φορές· μπορείτε να ζητήσετε επιπλέον κύκλο. Αποδεκτό σημαίνει παραλαβή από τον διακομιστή σας. Ελέγξτε εκεί την περαιτέρω επεξεργασία.

• Κατεβάστε τον οδηγό webhooks, ορίων και αποκατάστασης
• Κατεβάστε το παράδειγμα Node.js επαλήθευσης υπογραφής

Ο προσομοιωτής δεν στέλνει πραγματικές ειδοποιήσεις. Δοκιμάστε τον δέκτη με εικονικά δεδομένα και ξεχωριστή παραγωγική σύνδεση. Το παράδειγμα ελέγχει την ειδοποίηση· ο διακομιστής σας χειρίζεται αποθήκευση και συνέχεια.

Τι σημαίνει ο κωδικός σφάλματος;

Προστατέψτε κλειδί και δεδομένα πελατών

• Χρησιμοποιήστε το κλειδί μόνο στον διακομιστή, ποτέ σε δημόσιο κώδικα προγράμματος περιήγησης.
• Χρησιμοποιήστε ξεχωριστό κλειδί ανά ενσωμάτωση και ανακαλέστε τα παλιά.
• Μην τοποθετείτε κλειδιά, αποτελέσματα ή προσωρινούς συνδέσμους σε δημόσια αρχεία καταγραφής ή συνομιλίες.
• Αποθηκεύστε δεδομένα πελατών σύμφωνα με τους κανόνες πρόσβασης του συστήματός σας.