URLs API

Introduction

L’API ClicRDV fonctionne exclusivement en HTTPS (port 443).

Si vous essayez d'utiliser l'API en HTTP, vous obtiendrez le message d'erreur suivant :

Pour des raisons de sécurité, l'API ClicRDV n'est disponible qu'en HTTPS (port 443)

Pour utiliser l’API en production, l’URL de base est : https://www.clicrdv.com/api/v1/

ClicRDV se réserve le droit de modifier cette API à tout moment pour la résolution de bogues ou l’ajout de fonctionnalités.

Sandbox

Si votre utilisation de l'API nécessite l'accès en écriture, il est préférable de développer l'application sur notre plateforme de test (cf Sandbox / Bac à sable)

L'URL devient alors : https://sandbox.clicrdv.com/api/v1/

Member URL vs Collection URL

L'API distingue deux types d'URLs :

Collection URL

Les "collections" représentent une liste d’objets. Exemple :

https://www.clicrdv.com/api/v1/fiches

Ces URLs permettent l'accès à une liste, le filtrage, la pagination, ainsi que l'ajout de nouveaux éléments à une liste.

Member URL

Les URLs "membre" représentent un objet appartenant à une collection. Exemple :

https://www.clicrdv.com/api/v1/fiches/:id

Ces URLs permettent uniquement la lecture, la modification ou la suppression d'un élément.