Group API

Chez ClicRDV, un Groupe représente une entité (entreprise, magasin, cabinet, profession libérale...), partageant un fichier client commun (Fiche), utilisant un ou plusieurs agendas (Calendar), et proposant une liste de prestations (Intervention) à sa clientelle.

Récupèrer la liste des groupes :

GET /api/v1/groups?apikey=xxxxxxxx

Récupère les infos d’un groupe :

GET /api/v1/groups/:id?apikey=xxxxxxxx

Modifier les propriétés d'un groupe :

PUT /api/v1/groups/:id
{
  "apikey": "xxxxxxxx",
  "group": {
    "phone": "01 83 62 04 04"
  }
}

Champs standards :

name

string(255) - Nom de l’activité, de la société, du magasin ...

preposition

string(32) - Préposition du nom de l'activité/société (ex: chez Eric Plomberie)

phone

string(20) - Numéro de téléphone

fax

string(20) - Numéro de fax

address

string(255) - Adresse postale (rue)

city

string(64) - Ville

zipcode

string(6) - Code postal

country

string(255) - Pays

timezone

string(255) - Fuseau horaire (voir Annexe pour la liste des valeurs). Important : Les délais d'envois de RAPPELS email et sms sont basés sur ce fuseau horaire .

Champs liés aux envois d’email :

sendmail

boolean - Envoyer ou non les emails d’inscription, de confirmation, d'annulation et de modification des RDV (1 par défaut)

mailreminder

integer - Vous pouvez envoyer automatiquement à vos clients un RAPPEL e-mail avant tout RDV. Ce rappel peut être envoyé entre 1h et 48h avant le début du RDV. (valeur en minutes, ex: 240 pour 4h avant). Important: Pour ne pas envoyer d'emails de rappel, il faut lui attribuer la valeur 0 (valeur par défaut)

Champs liés aux envois de SMS :

country_code

string(10) - Indicatif téléphonique du pays (exemple : 33 pour la France, 32 pour la Belgique, 42 pour la Suisse)

smsreminder

integer - Vous pouvez envoyer automatiquement à vos clients un SMS de RAPPEL avant tout RDV. Ce rappel peut être envoyé entre 1h et 24h avant le début du RDV. Pour ne pas déranger vos clients le soir ou la nuit, les rappels SMS sont envoyés seulement en journée (entre 9h et 19h). Si l'envoi du rappel tombe en dehors de cette période, il sera automatiquement envoyé la veille du RDV. (valeur en minutes, ex: 240 pour 4h avant). Important: Pour ne pas envoyer de SMS de rappel, il faut lui attribuer la valeur 0 (valeur par défaut)

sms_sender_name

string(11) - Permet de personnaliser l'expéditeur SMS à la place de celui par défaut, pour que vos clients puissent vous rappeler au numéro de votre choix, ou qu'il y ait affiché le nom de votre activité (exemple : CentreSoins ou un numéro international à 11 chiffres : +33183620404).

check_sms

boolean - Spécifie si la case « Rappel SMS » est cochée ou non par défaut lors de la création d'un nouveau RDV dans l'Interface Pro du logiciel ClicRDV.(1 par défaut)

Champs liés à la prise de RDV par Internet :

inactive

boolean - Indique si la prise de RDV par Internet est désactivée (0 par défaut)

open

boolean - Indique si tout le monde peut prendre RDV par Internet, ou si seuls les clients ayant déjà une Fiche comportant leur adresse e-mail peuvent prendre RDV (1 par défaut) (Permet par exemple de limiter la prise de RDV aux personnes déjà venues et qui ont donné leur adresse e-mail)

openData

boolean - Indique si le groupe ouvre ses disponibilités à des utilisateurs non-identifiés (1 par défaut) (Permet aux gens de choisir un RDV avant de s'authentifier, ou de les obliger à s'authentifier pour choisir)

calendarChoice

integer - Spécifie le déroulement de la prise de RDV par Internet, soit l'utilisateur choisit :

• d'abord le type de RDV, puis l'Agenda (valeur : 2 , valeur par défaut)
• d'abord l'Agenda, puis le type de RDV (valeur : 1 )
• le type de RDV seulement, pas le choix de l'Agenda (valeur : 0 )

anyCalendar

boolean - Spécifie si il y aura une option 'sans préférence' au moment de choisir d'Agenda (si on laisse le choix de l'Agenda)(1 par défaut)

max_multirdvs

integer - Spécifie le nombre maximum de RDV consécutifs qu'un utilisateur peut prendre en même temps (1 par défaut)

usercolors

string(255) - Chaîne de caractères au format JSON pour personnaliser les couleurs de l'interface de prise de RDV. (exemple: {"selectedTabText": "#FFFFFF", "contentBox": "#EFF9FF", "hoverTabBg": "#EFF9FF", "selectedTabBg": "#4AA0E0", "outsidePage": "#FFFFFF", "selectedTabBorder": "#0A60a0"} (NULL par défaut)

Annexes Timezones

Par exemple, pour Europe/Paris, vous devez stocker Paris le champ timezone de l'objet « Groupe »

MAPPING = { "International Date Line West" => "Pacific/Midway", "Midway Island" => "Pacific/Midway", "Samoa" => "Pacific/Pago_Pago", "Hawaii" => "Pacific/Honolulu", "Alaska" => "America/Juneau", "Pacific Time (US & Canada)" => "America/Los_Angeles", "Tijuana" => "America/Tijuana", "Mountain Time (US & Canada)" => "America/Denver", "Arizona" => "America/Phoenix", "Chihuahua" => "America/Chihuahua", "Mazatlan" => "America/Mazatlan", "Central Time (US & Canada)" => "America/Chicago", "Saskatchewan" => "America/Regina", "Guadalajara" => "America/Mexico_City", "Mexico City" => "America/Mexico_City", "Monterrey" => "America/Monterrey", "Central America" => "America/Guatemala", "Eastern Time (US & Canada)" => "America/New_York", "Indiana (East)" => "America/Indiana/Indianapolis", "Bogota" => "America/Bogota", "Lima" => "America/Lima", "Quito" => "America/Lima", "Atlantic Time (Canada)" => "America/Halifax", "Caracas" => "America/Caracas", "La Paz" => "America/La_Paz", "Santiago" => "America/Santiago", "Newfoundland" => "America/St_Johns", "Brasilia" => "America/Sao_Paulo", "Buenos Aires" => "America/Argentina/Buenos_Aires", "Georgetown" => "America/Argentina/San_Juan", "Greenland" => "America/Godthab", "Mid-Atlantic" => "Atlantic/South_Georgia", "Azores" => "Atlantic/Azores", "Cape Verde Is." => "Atlantic/Cape_Verde", "Dublin" => "Europe/Dublin", "Edinburgh" => "Europe/Dublin", "Lisbon" => "Europe/Lisbon", "London" => "Europe/London", "Casablanca" => "Africa/Casablanca", "Monrovia" => "Africa/Monrovia", "UTC" => "Etc/UTC", "Belgrade" => "Europe/Belgrade", "Bratislava" => "Europe/Bratislava", "Budapest" => "Europe/Budapest", "Ljubljana" => "Europe/Ljubljana", "Prague" => "Europe/Prague", "Sarajevo" => "Europe/Sarajevo", "Skopje" => "Europe/Skopje", "Warsaw" => "Europe/Warsaw", "Zagreb" => "Europe/Zagreb", "Brussels" => "Europe/Brussels", "Copenhagen" => "Europe/Copenhagen", "Madrid" => "Europe/Madrid", "Paris" => "Europe/Paris", "Amsterdam" => "Europe/Amsterdam", "Berlin" => "Europe/Berlin", "Bern" => "Europe/Berlin", "Rome" => "Europe/Rome", "Stockholm" => "Europe/Stockholm", "Vienna" => "Europe/Vienna", "West Central Africa" => "Africa/Algiers", "Bucharest" => "Europe/Bucharest", "Cairo" => "Africa/Cairo", "Helsinki" => "Europe/Helsinki", "Kyev" => "Europe/Kiev", "Riga" => "Europe/Riga", "Sofia" => "Europe/Sofia", "Tallinn" => "Europe/Tallinn", "Vilnius" => "Europe/Vilnius", "Athens" => "Europe/Athens", "Istanbul" => "Europe/Istanbul", "Minsk" => "Europe/Minsk", "Jerusalem" => "Asia/Jerusalem", "Harare" => "Africa/Harare", "Pretoria" => "Africa/Johannesburg", "Moscow" => "Europe/Moscow", "St. Petersburg" => "Europe/Moscow", "Volgograd" => "Europe/Moscow", "Kuwait" => "Asia/Kuwait", "Riyadh" => "Asia/Riyadh", "Nairobi" => "Africa/Nairobi", "Baghdad" => "Asia/Baghdad", "Tehran" => "Asia/Tehran", "Abu Dhabi" => "Asia/Muscat", "Muscat" => "Asia/Muscat", "Baku" => "Asia/Baku", "Tbilisi" => "Asia/Tbilisi", "Yerevan" => "Asia/Yerevan", "Kabul" => "Asia/Kabul", "Ekaterinburg" => "Asia/Yekaterinburg", "Islamabad" => "Asia/Karachi", "Karachi" => "Asia/Karachi", "Tashkent" => "Asia/Tashkent", "Chennai" => "Asia/Kolkata", "Kolkata" => "Asia/Kolkata", "Mumbai" => "Asia/Kolkata", "New Delhi" => "Asia/Kolkata", "Kathmandu" => "Asia/Katmandu", "Astana" => "Asia/Dhaka", "Dhaka" => "Asia/Dhaka", "Sri Jayawardenepura" => "Asia/Colombo", "Almaty" => "Asia/Almaty", "Novosibirsk" => "Asia/Novosibirsk", "Rangoon" => "Asia/Rangoon", "Bangkok" => "Asia/Bangkok", "Hanoi" => "Asia/Bangkok", "Jakarta" => "Asia/Jakarta", "Krasnoyarsk" => "Asia/Krasnoyarsk", "Beijing" => "Asia/Shanghai", "Chongqing" => "Asia/Chongqing", "Hong Kong" => "Asia/Hong_Kong", "Urumqi" => "Asia/Urumqi", "Kuala Lumpur" => "Asia/Kuala_Lumpur", "Singapore" => "Asia/Singapore", "Taipei" => "Asia/Taipei", "Perth" => "Australia/Perth", "Irkutsk" => "Asia/Irkutsk", "Ulaan Bataar" => "Asia/Ulaanbaatar", "Seoul" => "Asia/Seoul", "Osaka" => "Asia/Tokyo", "Sapporo" => "Asia/Tokyo", "Tokyo" => "Asia/Tokyo", "Yakutsk" => "Asia/Yakutsk", "Darwin" => "Australia/Darwin", "Adelaide" => "Australia/Adelaide", "Canberra" => "Australia/Melbourne", "Melbourne" => "Australia/Melbourne", "Sydney" => "Australia/Sydney", "Brisbane" => "Australia/Brisbane", "Hobart" => "Australia/Hobart", "Vladivostok" => "Asia/Vladivostok", "Guam" => "Pacific/Guam", "Port Moresby" => "Pacific/Port_Moresby", "Magadan" => "Asia/Magadan", "Solomon Is." => "Asia/Magadan", "New Caledonia" => "Pacific/Noumea", "Fiji" => "Pacific/Fiji", "Kamchatka" => "Asia/Kamchatka", "Marshall Is." => "Pacific/Majuro", "Auckland" => "Pacific/Auckland", "Wellington" => "Pacific/Auckland", "Nuku'alofa" => "Pacific/Tongatapu" }