Pomoc

API dla programistów

Połącz oprogramowanie przez jawne działania dotyczące źródeł, przetwarzania, wyników i zarządzania. Ten przewodnik opisuje dostępne API w granicach udokumentowanych ograniczeń wydania. Użytkownik, uprawnienia, miejsce i kredyty pozostają powiązane z kontem Rapportly.

Przygotuj integrację w trzech krokach

1. 1
   Wybierz użytkownika, środowisko i uprawnienia

   Otwórz Konto → Integracje. Użyj klucza testowego do fikcyjnego symulatora, a oddzielnego klucza produkcyjnego do rzeczywistych działań z fikcyjnymi danymi. Administrator nadaje tylko potrzebne uprawnienia i odpowiedni budżet.

2. 2
   Przećwicz odbiór i błędy

   Zacznij od symulatora. Następnie zaimportuj kontrakty API i przejrzyj syntetyczne przykłady. Sekrety pozostają na serwerze; zmiany są domyślnie wyłączone w kolekcji.

3. 3
   Prześledź całe zlecenie

   Zapisz dane i identyfikator, sprawdź rozpoczęcie i stan końcowy, odczytaj wynik, pobierz dostępny plik i sprawdź zużycie. Wykonaj tę próbę dopiero w zatwierdzonym środowisku.

Utwórz klucz API

Adres bazowy

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

Klucz należy do użytkownika

Klucz deleguje uprawnienia jednego użytkownika. Administrator ustala środowisko, limit uprawnień, miesięczny budżet i termin ważności. Członek zespołu aktywuje przygotowany klucz i widzi sekret jeden raz. Każde żądanie sprawdza też aktualne uprawnienia użytkownika, pakietu i obiektu. Zarządzanie kluczami korzysta z sesji użytkownika; działania produkcyjne z klucza API. Przechowuj sekrety na serwerze, a utracony klucz unieważnij w Konto → Integracje. Zdarzenia Zapier mają osobny kontrakt.

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

Używaj konkretnych kontraktów i przykładów

Produkcyjne OpenAPI opisuje kontrakty kodu i oznacza częściowe dane lub odpowiedzi. Wykaz pokazuje otwarte schematy. Kolekcja Postman zaczyna od nieprawidłowego adresu, pustych kluczy i wyłączonych zmian. Importuj do przeglądu i świadomie wysyłaj fikcyjne dane w zatwierdzonym środowisku. Import nie został jeszcze przetestowany.

• Pobierz specyfikację produkcyjnego OpenAPI
• Pobierz syntetyczną kolekcję Postman
• Pobierz przebieg od źródła do pobrania
• Pobierz wykaz schematów i otwartych elementów

Najpierw ćwicz na fikcyjnych zleceniach

Utwórz klucz testowy i przećwicz zlecenia w toku, wyniki, błędy i niewystarczający budżet. Symulator używa stałych przykładów i nie kosztuje kredytów.

1. W Konto → Integracje utwórz lub aktywuj klucz Test z prawami, które chcesz przećwiczyć.
2. Pobierz GET /test/scenarios i wybierz działanie z odpowiedzi. Lista uwzględnia aktualne uprawnienia.
3. Wyślij POST /test/opdrachten tylko z actie i scenario: succes, verwerking_mislukt, creditbudget_bereikt lub toegang_geweigerd. Każde nowe ćwiczenie ma własny Idempotency-Key.
4. Zapisz opdracht_id. Przy bezig odczytaj GET /test/opdrachten/{id} po około pięciu sekundach. Zawsze sprawdzaj stan: HTTP200 może też zawierać błąd przetwarzania.

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

Przykład wymaga rapport.start na liście działań. Po problemie z połączeniem powtórz te same dane i Idempotency-Key.

• Pobierz przewodnik symulatora
• Pobierz ćwiczeniową kolekcję Postman
• Pobierz OpenAPI symulatora

Pobieraj tylko potrzebne dane

Wyszukuj dostępne foldery klientów, rozmowy i raporty. /acties pokazuje działania i uprawnienia, /gebruik budżet i rezerwacje, /verzoeken historię techniczną. Trwające przetwarzanie nie ma jeszcze wyniku. Linki do raportów są ważne 15 minut; odczytaj raport ponownie, aby uzyskać nowy link.

Aktualizuj zarządzanie klientami

Twoje oprogramowanie może modyfikować szablony biura, zapisywać osobiste wyszukiwania, rejestrować wizyty i tworzyć procesy obsługi. Korzystaj z odpowiednich uprawnień administracyjnych i potwierdzaj każdą zmianę. Najpierw odczytaj aktualną wersję, a w razie utraty odpowiedzi zachowaj ten sam identyfikator żądania. Ponowienie starego żądania nie może cofnąć nowszej zmiany. Test produkcyjny sprawdza wyszukiwania, wizyty i procesy obsługi, w tym usuwanie danych testowych i unieważnianie kluczy. Szablony biura były w nim tylko odczytywane; zapis przetestowano lokalnie i w CI. Przewodnik do pobrania opisuje cztery trasy i zakres ich dowodów.

Porównaj dwie zapisane wersje

Porównaj dwa istniejące numery wersji tego samego zapisanego pola tekstowego raportu lub pola rozmowy bez nowego przetwarzania przez AI. Ten kontrakt przetestowano lokalnie i w CI; test produkcyjny CRM nie potwierdza działania porównywania w środowisku produkcyjnym. Brakująca historia nie jest uzupełniana bieżącym tekstem. Długie różnice są skracane do maksymalnie 8000 znaków na stronę, z widocznym oznaczeniem skrócenia. Porównanie nie obejmuje prezentacji PowerPoint, kalkulacji ofert, listów przewodnich ani formatowania. Nadal obowiązują aktualne uprawnienia do odczytu i warunki prywatności.

Poproś wcześniej o oszacowanie kosztu

POST /generatieplan pokazuje przewidywane etapy i kredyty dla raportu, oferty lub rozmowy. Użyj gebruik:lezen. Obliczenia i ustawienia zespołu odpowiadają stronie.

Oszacowanie nie uruchamia przetwarzania ani nie pobiera kredytów. Nie jest gwarantowaną ceną maksymalną. Pokazuj niepewność, np. nieznane jeszcze koszty odczytu plików. Rozpoczęcie ponownie sprawdza uprawnienia i kredyty.

Pobierz przewodnik szacowania i przykłady

Rozpocznij przetwarzanie ze swojego oprogramowania

API łączy sprawy, dokumenty, przesyłanie plików, dźwięk, transkrypcję, foldery klientów, style, wyniki, procesy, Excel i ukierunkowane wiadomości. Każda trasa ma własne dane, uprawnienia, potwierdzenia i kontrolę wersji. Nadal obowiązują istniejące przetwarzanie i rozliczanie kredytów. Odpowiedź początkowa potwierdza odbiór; następnie odczytaj stan. Wykaz wskazuje otwarte kontrakty.

Najpierw utwórz sprawę

Wygeneruj i zachowaj UUID. Wyślij PUT /dossiers/{id} tylko z naam, maksymalnie 200 znaków. 201 oznacza utworzenie, 200 identyczne powtórzenie. Sprawa należy do użytkownika i organizacji klucza i nie kosztuje kredytów. Inne dane zwracają 409; niedostępna lub usunięta sprawa 404. GET /dossiers/{id} odczytuje naam i klant_id z uprawnieniem odczytu.

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

Raport, oferta lub prezentacja

Zacznij od dossierId i notities. tier jest opcjonalne: basis, standaard lub max. Bez profilu stylu stosowany jest neutralny wygląd. Możesz dodać dostępne stijlprofielId, klantId, bronOpnameIds i taal. Styl musi pasować do typu dokumentu. Oferty korzystają z ustawień firmy i bezpiecznej numeracji; API nie wysyła ich klientowi.

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

Zapisz versie_id i śledź GET /rapporten/{versie_id}, także dla ofert i prezentacji. Przy klaar obiekt resultaat zawiera dostępne pliki: export_url dla PDF, export_url_docx dla Worda i export_url_pptx dla PowerPointa. Linki są ważne 15 minut. Przy mislukt sprawdź przetwarzanie i zużycie przed automatycznym rozpoczęciem nowego zlecenia z innym kluczem.

Pobierz przebieg od źródła do pobrania

Prześlij własne przykłady stylu

Wyślij od jednego do trzech plików jako pełny zestaw. Rapportly stosuje te same kontrole plików i stylu co strona. Miejsce i kredyty należą do powiązanego użytkownika.

1. Wyślij pliki, nazwę, typ dokumentu, zakres osobisty lub zespołowy, wyraźne potwierdzenie i stały identyfikator. Styl zespołowy wymaga administratora lub lidera zespołu.
2. Zapisz identyfikator odbioru i odczytuj stan. Odebrano oznacza zapis kompletnego zestawu; kontrola podglądu i zatwierdzenie mogą nastąpić później.
3. Po przerwaniu powtórz dokładnie to samo żądanie bez tworzenia drugiego stylu. Niekompletne przesłania można powtarzać przez trzydzieści dni; później są kontrolowanie usuwane.

Pobierz przewodnik przykładów stylu, multipart i błędów

Połącz kalendarz lub skrzynkę pocztową

Użytkownik sam udziela zgody w Google lub Microsoft. Oprogramowanie śledzi żądanie i może świadomie zakończyć połączenie. Hasła i tokeny dostawcy nie pojawiają się w odpowiedzi.

Użyj verbindingen:beheren do połączeń i agenda:lezen do spotkań. Wysyłanie wymaga też uprawnienia do wysyłki i świadomego zlecenia.

Zapisz numer żądania, identyfikator i aktualną podstawę. Powtarzaj utracone żądania dokładnie; stare rozłączenie nie może usuwać późniejszego połączenia.

API może wybrać domyślną skrzynkę z uprawnieniami zarządzania i wysyłki. Najpierw odczytaj aktualny wybór i połączenie. Stare powtórzenie nie zmienia nowszego wyboru; istniejące wysyłki zachowują nadawcę.

Pobierz kroki zgody, spotkań, rozłączenia i odzyskiwania

Pakiet wyników rozmowy z tekstu

Wyślij transkrypcję liczącą co najmniej sto znaków. Śledź wynik przez gesprek_id. Opcjonalne: 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"
}

Odczyt istniejących wersji językowych

Odczytuj istniejące wyniki językowe. Opisane trasy przepływu pracy do uruchamiania, wstrzymywania, wznawiania i przywracania przetwarzania przetestowano lokalnie i w CI; test produkcyjny CRM nie potwierdza tego przetwarzania językowego. Używaj ich wyłącznie w środowisku dopuszczonym do tego celu. Pierwotny użytkownik, klucz, źródło i koszty pozostają powiązane z żądaniem. Nadal wymagane są aktualny stan źródła, uprawnienia, budżet i zweryfikowane rozliczenie; wygasłe lub usunięte źródło nie uprawnia do ponownego uruchomienia. Przetwarzanie zbiorcze z włączonym drugim językiem pozostaje zablokowane, również przy ustawieniach odziedziczonych. Płatne uzupełnianie pojedynczego brakującego wyniku tłumaczenia nadal jest wykluczone.

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

Otrzymuj powiadomienia o zakończeniu przetwarzania

Rapportly może przesłać techniczne odwołania na Twój serwer. Następnie pobierz treść z odpowiednimi prawami odczytu bez ciągłego pytania o postęp.

1. Utwórz odbiornik HTTPS i zarejestruj go przez POST /webhooks z webhooks:beheren. Użyj tego samego klucza produkcyjnego dla odpowiednich zleceń.
2. Sprawdź podpis na oryginalnych bajtach wiadomości i zapisuj każdy identyfikator zdarzenia tylko raz. Potwierdź po bezpiecznym zapisie wraz z następnym zadaniem. Powtórzenie nie może tworzyć drugiego zlecenia.
3. Odczytaj GET /webhook-afleveringen i szczegóły dostarczenia. Błędy tymczasowe są ponawiane maksymalnie osiem razy; można zamówić dodatkową rundę. Przyjęto oznacza odbiór przez Twój serwer. Sprawdź tam dalsze przetwarzanie.

• Pobierz przewodnik webhooków, limitów i odzyskiwania
• Pobierz przykład Node.js do weryfikacji podpisu

Symulator nie wysyła prawdziwych powiadomień. Sprawdź odbiornik z fikcyjnymi danymi i osobnym połączeniem produkcyjnym. Przykład weryfikuje wiadomość; Twój serwer zapewnia zapis i dalsze działania.

Co oznacza kod błędu?

Chroń klucz i dane klientów

• Używaj klucza tylko na swoim serwerze, nigdy w publicznym kodzie przeglądarki.
• Używaj osobnego klucza dla każdej integracji i unieważniaj stare.
• Nie umieszczaj kluczy, wyników ani tymczasowych linków w publicznych logach lub czatach.
• Przechowuj pobrane dane klientów zgodnie z zasadami dostępu swojego systemu.