All plans have 30% OFF For this week
Claim Discount
API referentie
API referentie
API Reference
Welcome to the AnswerPal API Reference. Here you’ll find everything you need to integrate, automate, and extend AnswerPal using our secure and flexible RESTful API. Browse the sections below to get started, find endpoint documentation, and access best practices for robust integrations.
Introduction
AnswerPal provides a comprehensive, RESTful API to automate, extend, and integrate every aspect of your customer service, support, and communications workflows. Whether you’re building custom integrations, automating ticket handling, or connecting AnswerPal with your CRM, ERP, or other tools, our 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.
Authentication
All API requests require authentication. AnswerPal supports both Basic Authentication and Bearer (JWT) tokens. Credentials can be set at the organization level or overridden for specific actions, documents, or custom fields. For details, see the Authentication section.
Endpoints Overview
Explore all API endpoints available in AnswerPal. Each group below summarizes its purpose and main API paths. Click “View Details” for complete documentation and examples.
⚙️
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. Endpoints 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. Endpoints 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. Endpoints 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. Endpoints 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. Endpoints 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.
Support
Table of Contents
AnswerPal: AI-powered customer service solutions to elevate your support and communication effortlessly.
Quick Links
Contact
For all support, sales, and partnership inquiries, email us at info@answerpal.eu
