Met de openbare API van Chatway kunt u uw applicaties en services koppelen aan Chatway.
Met behulp van de API kunt u contacten beheren, gesprekken openen en berichten verzenden zonder het Chatway-dashboard te gebruiken. Uw systeem kan rechtstreeks verzoeken naar Chatway sturen om deze acties automatisch uit te voeren. Dit is handig als u Chatway wilt koppelen aan tools zoals:
- CRM
- E-commerceplatforms
- Hulpmiddelen voor klantenondersteuning
En meer.
Dit is een betaalde functie van Chatway, maar kan ook binnen het gratis proefabonnement worden gebruikt. Houd er rekening mee dat als de API-sleutel tijdens de gratis proefperiode wordt aangemaakt, deze wordt ingetrokken zodra je overstapt naar het gratis abonnement.
Raadpleeg de officiële API-documentatie van Chatway hier.
Wat je kunt doen met de Chatway API
Je kunt de Chatway API gebruiken om veelvoorkomende chatworkflows te automatiseren. Voorbeelden hiervan zijn:
• Contactgegevens van bezoekers aanmaken en bijwerken
• Gesprekken en chatberichten ophalen
• Berichten verzenden vanuit uw systeem
• Gesprekken automatisch afhandelen
• Chatgegevens synchroniseren met externe tools zoals CRM-systemen
Hierdoor kunt u Chatway integreren in uw bestaande systemen en workflows.
Een API-sleutel genereren in Chatway
Om de API te gebruiken, moet u eerst een API-sleutel aanmaken. Zo genereert u deze:
Stap 1 : Open het Chatway-dashboard en klik op 'Instellingen':
Houd er rekening mee dat alleen beheerders en eigenaren API-sleutels kunnen genereren.
Stap 2 : Klik op 'Ontwikkelaarstools'.
Stap 3 : Klik hier op 'API-sleutel genereren' en geef uw API-sleutel in de volgende stap een naam.
Stap 4: Nadat u een sleutel hebt aangemaakt, moet u ervoor zorgen dat u de sleutel kopieert en veilig bewaart.
Chatway toont de volledige API-sleutel slechts één keer, namelijk bij het aanmaken ervan. Na de aanmaak ziet u in uw dashboard slechts een gedeeltelijke weergave. Bijvoorbeeld:
Belangrijke beperkingen:
• Je kunt maximaal 5 actieve API-sleutels hebben.
• U kunt sleutels op elk moment intrekken.
• Ingetrokken sleutels kunnen niet worden hersteld.
API-verzoeken verifiëren
Elke API-aanvraag moet uw API-sleutel in de aanvraagheader bevatten. Bijvoorbeeld:
X-API-KEY: uw_api_sleutel_hier
Als de API-sleutel ontbreekt of ongeldig is, wordt het verzoek niet verwerkt. In plaats daarvan wordt een 401 Unauthorized-foutmelding geretourneerd. Bijvoorbeeld:
Basis URL
Alle Chatway API-verzoeken gebruiken de volgende basis-URL:
https://developers.chatway.app/api/v1Voorbeelden van aanvraag-URL's die u kunt gebruiken:
https://developers.chatway.app/api/v1/contacts (lists contacts)Tarieflimieten
Om stabiele prestaties te garanderen, beperkt de Chatway API het aantal verzoeken. Voor betaalde abonnementen is dit 60 verzoeken per minuut. Als uw applicatie deze limiet overschrijdt, kunnen verdere verzoeken tijdelijk worden geweigerd.
Kern-API-gebieden
De Chatway API is onderverdeeld in verschillende hoofdgebieden.
Contacten
Met de Contacten API kunt u bezoekersinformatie beheren. Enkele voorbeelden van gebruiksscenario's zijn:
| Actie | Endpoint | Voorbeeld gebruik |
| Contact maken | POST | Voeg een nieuwe bezoeker toe wanneer iemand zich aanmeldt op uw site. |
| Contactpersoon bijwerken | PATCH | Update de bezoekersgegevens wanneer ze hun e-mailadres of abonnement wijzigen. |
| Neem contact op | GET | Haal het volledige profiel en de chatgeschiedenis van een gebruiker op. |
| Lijst met contactpersonen | GET | Haal al je contacten op uit Chatway. |
Gesprekken
Met de Conversations API kunt u chatgesprekken openen en beheren. Voorbeelden van gebruiksscenario's zijn:
| Actie | Endpoint | Voorbeeld gebruik |
| Lijst met gesprekken ophalen | GET | Toon Chatway-chats in het CRM-dashboard. |
| Berichten in een gesprek ontvangen | GET | Haal de volledige chatgeschiedenis van een gesprek op. |
| Het gesprek beëindigen | POST | Chats automatisch afhandelen wanneer het ticket in een ander systeem wordt gesloten. |
Berichten
Met de Messages API kan uw systeem berichten verzenden via Chatway, zoals:
• Orderbevestigingen
• Verzendmeldingen
• Ondersteuningsupdates
Bijvoorbeeld:
| Actie | Endpoint | Voorbeeld gebruik |
| Bericht verzenden | POST | Stuur een bedankje nadat de bestelling is afgerond. |
Daarnaast kun je de widgets en de agentgegevens ook manipuleren met behulp van de Chatway API.
Foutverwerking
Als een verzoek mislukt, retourneert de API een foutreactie met een statuscode. Veelvoorkomende statuscodes zijn onder andere:
• 200 — Verzoek succesvol
• 201 — Bron succesvol aangemaakt
• 401 — Ongeautoriseerd verzoek
• 404 — Bron niet gevonden
• 422 — Validatiefout
Controleer de reactiebody voor meer informatie over de fout.
API-referentie
Deze handleiding geeft een overzicht van de Chatway API.
Voor volledige technische details, inclusief verzoekparameters, voorbeelden van reacties en schema-definities, raadpleegt u de Chatway API-documentatie.