Gratis setup bij jaarabonnementen
Nu inschrijven
API-referentie
API-referentie
API-referentie
Welkom bij de AnswerPal API-referentie. Hier vind je alles om AnswerPal te integreren, automatiseren en uitbreiden met onze veilige en flexibele REST API. Bekijk de secties hieronder om te starten, endpointdocumentatie te vinden en best practices voor betrouwbare integraties te raadplegen.
Introductie
AnswerPal biedt een uitgebreide REST API om elk onderdeel van je klantenservice, ondersteuning en communicatieworkflows te automatiseren, uit te breiden en te integreren. Of je nu maatwerkintegraties bouwt, ticketafhandeling automatiseert of AnswerPal koppelt aan je CRM, ERP of andere tools, onze API gives you secure, flexible, and scalable access to all platform features.
RESTful JSON API
Standaard HTTP methodes en JSON payloads voor makkelijke integratie.
Veilige authenticatie
Ondersteunt Basic en Bearer (JWT) authenticatie voor alle endpoints.
Real-time automatisering
Trigger workflows en acties onmiddellijk met webhooks en events.
Uitbreidbaar & flexibel
Koppel aangepaste velden, verbind met externe API's, en pas workflows aan naar jouw behoeften.
Authenticatie
Alle API-aanvragen vereisen authenticatie. AnswerPal ondersteunt zowel Basic Authenticatie als Bearer-tokens (JWT). Inloggegevens kunnen op organisatieniveau worden ingesteld of overschreven voor specifieke acties, documenten of aangepaste velden. Zie de sectie Authenticatie voor details.
Overzicht van endpoints
Bekijk alle beschikbare API-endpoints in AnswerPal. Elke groep hieronder vat het doel en de belangrijkste API-paden samen. Klik op “Details bekijken” voor volledige documentatie en voorbeelden.
⚙️
acties
Beheer automatiseringsacties - vooraf gedefinieerde operaties getriggerd door workflows en events. Gebruik deze endpoints om acties voor het automatiseren van antwoorden, API oproepen, ticketafsluiting en meer te lijsten, maken, updaten en verwijderen.
📡
Kanalen
Beheer communicatiestromen zoals e-mail, chat, telefoon en WhatsApp. Met endpoints kun je kanalen lijsten, maken, updaten en verwijderen, en ook mappen en vertalingen beheren.
🏢
Klanten
Toegang tot en beheer van het profiel van je organisatie, integratiegeheimen en beschikbare AI-modellen. Deze endpoints zijn voor het ophalen en updaten van klantaccountgegevens.
📄
Documenten
Beheer statische documenten (kennisbank, templates) en dynamische data-ophaalprocessen. Eindpunten omvatten het lijsten, maken, updaten en verwijderen van documenten of definities voor data-ophaling.
👤
Eindgebruikers
Beheer individuen die met je organisatie interacteren - klanten, medewerkers of partners. Eindpunten ondersteunen het maken, ophalen, updaten, zoeken en verwijderen van eindgebruikers, en het beheren van hun unieke identifiers.
📎
Bestand
Upload, download en beheer bijlagen gerelateerd aan ticketberichten. Eindpunten maken veilige bestandsverwerking mogelijk voor zowel eindgebruikers als klantenservice medewerkers.
⏰
Hooks (events)
Automatiseer acties getriggerd door specifieke events (“hooks”) in AnswerPal's workflow. Met endpoints kun je event-getriggerde acties en documenten beheren via het SpecialTopic mechanisme.
🎫
Tickets
Beheer de volledige levenscyclus van klantenservicetickets, inclusief aanmaken, updaten en ophalen. Eindpunten omvatten ticketberichten, bijlagen en onderwerp-classificatie.
🏷️
Onderwerpen
Organiseer en classificeer gesprekken, tickets of berichten. Met endpoints kun je onderwerpen maken, updaten, ophalen en verwijderen, en onderwerp-gerelateerde acties, koppelingen en documenten beheren.
🌐
Vertalingen
Beheer gelokaliseerde UI- en berichtvertalingen voor kanalen. Eindpunten ondersteunen het ophalen en updaten van vertalingen voor elk communicatiekanaal.
🔄
Webhooks
Webhooks maken realtime automatisering mogelijk door je systemen te informeren wanneer specifieke events in AnswerPal plaatsvinden (zoals ticketaanmaak, escalatie of oplossing). Configureer webhooks om HTTP callbacks te ontvangen en je eigen workflows of integraties te triggeren.
❌
Foutcodes
De AnswerPal API gebruikt standaard HTTP statuscodes om het succes of falen van API verzoeken aan te geven. Bekijk de sectie Foutcodes voor een complete lijst en best practices voor foutafhandeling.
🚦
Gebruikslimieten
Om platformstabiliteit te garanderen, past de API limieten toe per klantorganisatie. Zie de sectie Limieten voor details, inclusief huidige drempels en hoe om te gaan met gelimiteerde responses.
✅
Best practices
Volg onze best practices gids voor veilige, betrouwbare en efficiënte API integraties. Onderwerpen zijn onder andere authenticatie, foutafhandeling, datavalidatie en prestatie-optimalisatie.
FAQ
Ja, alle eindpunten vereisen een geldig toegangstoken, tenzij anders vermeld.
De detailpagina van elk eindpunt bevat voorbeelden van verzoeken en antwoorden.
Ja, alle endpoints volgen REST-conventies met standaard HTTP methodes.
Ondersteuning
Inhoudsopgave
AnswerPal: AI-gedreven oplossingen voor klantenservice die uw support en communicatie moeiteloos versterken.
Snelle links
Contact
Voor support-, sales- en partnervragen kunt u mailen naar [email protected]
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerpen
België
+32.36416685
BE 0862.692.858