Revendeurs et franchiseurs : déployer des comptes par requêtes API

Créé par Mickaël VIDAL, Modifié le Lun, 27 Févr., 2023 à 10:44 H par Mickaël VIDAL

Comment créer et configurer des comptes clients via API

Pour déployer un grand nombre de comptes clients, il est possible de le faire par API. En combinant des appels API à un fichier de données CSV contenant la valeur des différents paramètres, le déploiement pourra se faire en une seule action sur plusieurs centaines de succursales/comptes clients.

Requêtes JSON

L'application Postman permet de faire appel à des données externes dans les requêtes. Les requêtes nécessaires à la création des comptes et leur configuration sont les suivantes :

Création du compte client : PUT http://api.agendize.com/api/2.0/resellers/accounts
Configuration du compte client : PUT http://api.agendize.com/api/2.0/accounts
Création d'une entreprise : POST http://api.agendize.com/api/2.1/scheduling/companies
Configuration de l'entreprise : PUT http://api.agendize.com/api/2.1/scheduling/companies/{{companyId}}/settings
Création d'un ou plusieurs équipiers : PUT https://api.agendize.com/api/2.0/scheduling/companies/{{companyId}}/staff
Création d'un ou plusieurs services : PUT https://api.agendize.com/api/2.1/scheduling/companies/{{companyId}}/services

D'autres requêtes peuvent venir compléter la configuration :

Configuration du widget de prise de rendez-vous : POST https://api.agendize.com/api/2.1/scheduling/widgetForms

Précision : si votre compte est hébergé sur le serveur france ou sante, il faudra remplacer api dans la requête par le nom du serveur.

Fichier de données

Le fichier contenant les données à injecter dans les requêtes doit être encodé en UTF-8 et au format CSV ou JSON. Les champs texte ne doivent pas contenir de guillemets.

Dans Postman, l'appel à une valeur externe se fait par la syntaxe suivante : "paramètre" : "{{nomColonne}}".

Chaque colonne du fichier CSV correspond à un paramètre, la première ligne contient le nom de ce paramètre à indiquer dans la requête comme indiqué ci-dessus.

Les champs doivent être séparés par des virgules.

Il n'est pas gênant d'avoir plus de colonnes que de paramètres utilisés dans les requêtes. Il faut simplement que toutes les colonnes existantes aient un nom dans la première ligne et que toutes les lignes possèdent le même nombre de colonnes (même nombre de virgules).

Explication des champs du fichier

Les champs avec * sont les champs obligatoires

Nom des champs	Explications
account.firstName, account.lastName, account.email*, account.name, account.lang, account.timeZone, pdfExportSize, defaultView	Informations génériques sur l’agence (compte fils de revendeur) Prénom et nom facultatifs, email obligatoire, langue, Fuseau horaire, format de papier pour les exports PDF, vue par défaut du calendrier (daily, weekly, monthly)
company.name*, company.email, company.phone, company.street, company.street2, company.zip, company.city, company.country, currency,company.externalId	Agence : Nom*, adresse email générique, numéro de téléphone, adresse ligne 1, adresse ligne 2, code postal, ville, pays, monnaie (EUR), identifiant externe
service1.name, service1.description, service1.duration, service1.capacity, service1.available, service1.extId	Informations sur les services : Nom, description, durée en minutes, nombre de rendez-vous simultanés (1 par défaut), Service disponible à la prise de rendez-vous, identifiant externe Chaque service aura les mêmes champs.
staff1.firstName, staff1.lastName*, staff1.gender, staff1.email, staff1.tel, staff1.tel2, staff1.desc	Équipier : prénom, nom*, genre, adresse email, Numéros de téléphone 1 et 2, description
staff1.monStartAm, staff1.monEndAm, staff1.monStartPm, staff1.monEndPm, staff1.tueStartAm, staff1.tueEndAm, staff1.tueStartPm, staff1.tueEndPm, staff1.wedStartAm, staff1.wedEndAm, staff1.wedStartPm, staff1.wedEndPm, staff1.thuStartAm, staff1.thuEndAm, staff1.thuStartPm, staff1.thuEndPm, staff1.friStartAm, staff1.friEndAm, staff1.friStartPm, staff1.friEndPm, staff1.samStartAm, staff1.samEndAm, staff1.samStartPm, staff1.samEndPm	Horaires de disponibilités de l’équipier (qui servent au calcul de disponibilité des créneaux dans le widget) : Equipier 1 lundi début de matinée (staff1.monStartAm), lundi fin de matinée (staff1.monEndAm), lundi début d’après-midi, lundi fin d’après-midi...
staff1.service1, staff1.service2, staff1.service3, staff1.service4, staff1.service5, staff1.service6, staff1.service7, staff1.service8	L’équipier est-il affecté aux services ? Indiquer “true” si oui, “false” si non.
staff1.available, staff1.extId	L’équipier est-il disponible à la prise de rendez-vous en ligne ? (“true” ou “false”) Identifiant externe de l’équipier

Authentification

Pour l'authentification, vous aurez besoin du code apiKey du compte Revendeur.

Pour la création du compte client et sa configuration vous aurez également besoin du token SSO du renvendeur.

Pour les autres requêtes sur les comptes client, il faudra utiliser l'apiKey du renvendeur et le tocken du compte client.

Liste des fichiers joints

Quelques exemples de fichiers JSON pour les requêtes, un exemple de collection Postman contenant les différentes requêtes et un fichier CSV modèle pour les données sont joints à cet article.