Gratis setup bij jaarabonnementen
Nu inschrijven!
Medewerkers
API-referentie: endpoints voor medewerkers
De Medewerkers API beheert medewerkersaccounts, toewijzingsgeschiktheid, activeren/deactiveren, wachtwoordwijzigingen en taalspecifieke handtekeningen.
Overzicht
Medewerkers zijn de gebruikers die tickets behandelen en AnswerPal configureren. Toegang wordt bepaald door de rol: beheerders kunnen gebruikers beheren, terwijl niet-beheerders enkel hun eigen profiel kunnen aanpassen en hun rol niet kunnen wijzigen.
Huidige endpoints
Endpointsectie voor medewerkers
| Methode | Pad | Toegang | Doel |
|---|---|---|---|
| GET | /api/CustomerReps | ManageUsers | Geeft een pagina met medewerkers terug. Optionele query: pageNumber, pageSize. |
| GET | /api/CustomerReps/assignable | Administrator/Supervisor | Geeft medewerkers terug die toewijzingen kunnen ontvangen. |
| GET | /api/CustomerReps/me | Bearer JWT | Geeft het profiel van de huidige medewerker terug. |
| GET | /api/CustomerReps/{id} | ManageUsers | Geeft één medewerker terug binnen de geverifieerde klant. |
| POST | /api/CustomerReps | Conditionele toegang | Maak een medewerker aan; anonieme bootstrap is enkel toegestaan voor de eerste gebruiker tijdens installatie. |
| PUT | /api/CustomerReps/{id} | Bearer JWT | Werk een medewerker bij. Niet-beheerders kunnen alleen zichzelf bijwerken en hun rol niet wijzigen. |
| DELETE | /api/CustomerReps/{id} | ManageUsers | Verwijder een medewerker. |
Lifecycle-endpoints
| Methode | Pad | Toegang | Doel |
|---|---|---|---|
| POST | /api/CustomerReps/{id}/activate | ManageUsers | Activeer een medewerker; conflicten met gebruikerslimieten geven UserLimitExceeded terug. |
| POST | /api/CustomerReps/{id}/deactivate | ManageUsers | Deactiveer een medewerker. |
| PUT | /api/CustomerReps/{id}/change-password | Bearer JWT | Wijzig een wachtwoord voor uzelf of, als beheerder, voor een andere medewerker binnen dezelfde klant. |
Signature-endpoints
| Methode | Pad | Toegang | Doel |
|---|---|---|---|
| GET | /api/CustomerReps/{id}/signatures | Bearer JWT | Lijst van medewerkershandtekeningen. |
| POST | /api/CustomerReps/{id}/signatures | Bearer JWT | Maak of werk een taalgebonden handtekening bij. |
| GET | /api/CustomerReps/{id}/signatures/{lang} | Bearer JWT | Lees één taalgebonden handtekening. |
| DELETE | /api/CustomerReps/{id}/signatures/{lang} | Bearer JWT | Verwijder één taalgebonden handtekening. |
Velden en DTO's
DTO-structuur
UserRole enum-waarden
Het role-veld maakt gebruik van de backend UserRole enum. De API serialiseert enum-waarden als strings; numerieke waarden worden hier getoond omdat backend, database en frontend dezelfde volgorde aanhouden.
| Gebied | Velden | Opmerkingen |
|---|---|---|
0 | RestrictedUser | Kan enkel tickets bekijken en behandelen die aan hem/haar toegewezen zijn. |
1 | Agent | Kan eigen tickets en niet-toegewezen tickets behandelen. |
2 | Supervisor | Kan alle tickets voor hun klant behandelen en rapporten bekijken, maar kan geen instellingen of gebruikers beheren. |
3 | Configurator | Kan functionele instellingen beheren zoals topics, hooks, kanalen, modellen en vertalingen, maar kan geen gebruikers of facturatie beheren. |
4 | Administrator | Volledige toegang, inclusief beheer van gebruikers en rollen, zichtbaarheid op facturatie, instellingen en rapporten. |
5 | Analyst | Alleen-lezen toegang tot rapportagedashboards; geen toegang tot tickets of instellingen. |
Hoogtepunten van rolbeleid
Medewerkerrollen worden ook gebruikt door benoemde autorisatiepolicies.
| Gebied | Velden | Opmerkingen |
|---|---|---|
| TicketAccess | RestrictedUser, Agent, Supervisor, Configurator, Administrator | Analyst is uitgesloten van ticketbewerkingen. |
| ManageSettings | Configurator, Administrator | Laat toe om instellingen te wijzigen zoals kanalen, topics, hooks, modellen en vertalingen. |
| ManageUsers | Administrator | Vereist voor endpoints voor het beheren van medewerkergebruikers. |
| ViewReports | Supervisor, Configurator, Administrator, Analyst | Wordt gebruikt door rapportage-endpoints zoals opslag- en kostenrapporten. |
| ViewBilling | Administrator | Facturatie-informatie is enkel zichtbaar voor admins. |
| ImportEmails | Agent, Supervisor, Configurator, Administrator | Wordt gebruikt om e-mails te importeren. |
CustomerRepCreateDTO, CustomerRepUpdateDTO en CustomerRepReadDTO
Profiel- en rolpayloads voor medewerkergebruikers.
| Gebied | Velden | Opmerkingen |
|---|---|---|
| Credentials aanmaken | username, password | Vereist bij aanmaken. Username max 254; wachtwoord minimaal 6 tekens. |
| Identiteit | customerRepID, username | customerRepID wordt geretourneerd bij lezen en is vereist bij wijzigen/wachtwoordwijziging. |
| Profiel | name, email, phoneNumber, otherDetails | E-mailadres moet geldig zijn; telefoonnummer moet beginnen met + en bij opgave minstens 5 cijfers bevatten. |
| Lokalisatie | timeZone, locale, countryCode | Optionele lokalisatiewaarden. |
| Rol en status | role, isActive | role gebruikt de bovenvermelde UserRole-enum. Niet-admin gebruikers kunnen hun eigen rol niet wijzigen. |
| Legacy/standaard handtekeningen | emailSignatureHTML, emailSignatureText | Handtekeninginhoud op medewerkerniveau. Taalgebonden handtekeningen hebben aparte endpoints. |
CustomerRepSignatureCreateOrUpdateDTO en wachtwoordbodies
Kleine request bodies voor subresources van medewerkers.
| Gebied | Velden | Opmerkingen |
|---|---|---|
| Handtekening | lang, emailSignatureHTML, emailSignatureText | lang is ook de routeparameter voor read/delete. |
| Wachtwoord wijzigen | customerRepID, currentPassword, newPassword | Admins kunnen het wachtwoord van een andere medewerker binnen dezelfde klant wijzigen; gebruikers kunnen hun eigen wachtwoord aanpassen. |
Toegang en fouten
Beschermde endpoints maken gebruik van JWT Bearer-authenticatie en blijven beperkt tot de geauthenticeerde klant.
Inhoudsopgave
AnswerPal: AI-gedreven oplossingen voor klantenservice die je ondersteuning en communicatie moeiteloos versterken.
Snelle links
Contact
Voor ondersteunings-, commerciële en partnervragen kunt u mailen naar [email protected]
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerpen
België
+32.36416685
BE 0862.692.858