Cette page décrit les ressources /api/public/available_meetings et /api/public/agency_identifiers. Elles sont en lecture seule et servent à résoudre les identifiants que l’on retrouve ensuite dans vos rendez-vous. La génération de la clé d’API et les conventions communes sont décrites dans la page Utiliser l’API Apenday.
Lister vos événements #
curl "https://app.apenday.com/api/public/available_meetings" \
-H "X-AUTH-TOKEN: VOTRE_CLE_API" \
-H "Accept: application/ld+json"L’identifiant de l’événement n’est pas un champ de la réponse : il est porté par @id, sous la forme /api/public/available_meetings/IDENTIFIANT. C’est la valeur que l’on retrouve dans le champ meeting_id d’un rendez-vous.
Filtrer vos événements #
| Paramètre | Effet |
|---|---|
name | Recherche partielle sur le nom et le nom technique, ou correspondance exacte sur le slug |
technical_name | Recherche partielle sur le nom technique |
type | Type exact. Répéter type[] pour plusieurs valeurs |
enabled | true ou false |
consultant | Adresse e-mail ou identifiant externe d’un conseiller. Ne renvoie que les événements sur lesquels il a des disponibilités |
groups | Identifiant d’équipe. Répéter groups[] pour plusieurs valeurs |
Les champs d’un événement #
| Champ | Type | Contenu |
|---|---|---|
name | chaîne | Nom affiché de l’événement |
technical_name | chaîne ou null | Nom technique de l’événement |
type | chaîne | default, call, video ou other |
enabled | booléen | L’événement est ouvert à la prise de rendez-vous |
groups | tableau | Équipes rattachées, chacune avec id et name |
consultant_selection_policy | chaîne | Mode d’affectation du conseiller : by_team, by_user, by_priority, by_regular_dispatch ou mixed |
front_actions | objet | Contient la clé view, URL de la page publique de prise de rendez-vous |
Lister vos agences #
curl "https://app.apenday.com/api/public/agency_identifiers" \
-H "X-AUTH-TOKEN: VOTRE_CLE_API" \
-H "Accept: application/ld+json"| Champ | Type | Contenu |
|---|---|---|
name | chaîne | Nom de l’agence |
external_id | chaîne ou null | Identifiant de l’agence dans votre système |
Comme pour les événements, l’identifiant Apenday de l’agence est porté par @id, sous la forme /api/public/agency_identifiers/IDENTIFIANT.
Cette collection ne propose aucun filtre. Elle se parcourt par pages.
Rapprocher ces identifiants de vos rendez-vous #
| Valeur | Dans un rendez-vous | Dans la ressource de référence |
|---|---|---|
| Événement | meeting_id | @id d’un événement |
| Nom technique de l’événement | meeting_technical_name | technical_name |
| Agence | agency_id | @id d’une agence |
| Agence dans votre système | agency_external_id | external_id |
En pratique, chargez ces deux collections une fois, conservez la correspondance dans votre système, et rafraîchissez-la lorsque votre paramétrage évolue. Le détail des champs d’un rendez-vous est décrit dans la page Consulter et annuler des rendez-vous avec l’API.