ClicRDV REST API v1

The ClicRDV API is an interface for accessing your account data using HTTP. The API makes it easy to create web and desktop applications that integrate with your account.

Some potential application ideas:

  • Contact synchronization with a CRM
  • Appointment export to a billing software
  • Custom imports
  • Linked data analysis

About the ClicRDV API

ClicRDV provides a RESTful HTTP API, which means that the handling of a request depends on the following information:

  • the URL of the request,
  • the HTTP method (GET, POST, PUT, DELETE) of the request,
  • the parameters sent along with the request :
    • through the body of the request (POST and PUT requests),
    • or through the URL itself in all cases.

RESTful HTTP APIs follow the HTTP specification closely, as detailed on this wikipedia page.

Presentation of API calls

In this documentation, the examples of API calls will always be presented as follows:

1 
POST /api/v1/ressource.format?x=y&w=z
2 
{
    "key": "value"
    ...
}


1 On the first line, you find the HTTP method first (POST in this example), then a space character, then the URL of the request (/api/v1/ressource.format?x=y&w=z in this example).


For clarity of presentation, the URL displayed is intentionally shortened. It contains:

  • the "path" of the request, /api/v1/ressource.format in this example,
  • and, optionally, some parameters, ?x=y&w=z in this example.

When using the API, you'll need to prefix the "short" URL given by the base URL, from the production or the sandbox environment (see below).

Ex: /api/v1/groups/:group_id/calendars.json will become https://www.clicrdv.com/api/v1/groups/:group_id/calendars.json in production.

You'll also add all the information needed in the parameters, regarding the authentication (API key), the pagination, the formats (see below), a.s.o.

Ex: /api/v1/calendars could become in production: https://www.clicrdv.com/api/v1/groups/:group_id/calendars.json?apikey=xxxxxx&results=all


Note When the URL given contains keywords, identifiable by their first character equal to :, they are to be replaced by the values that suit your case. For example, the /api/v1/groups/:group_id/fiches/:id URL contains two keywords (:group_id and :id), that you'll need to remplace by numeric values, say like this: /api/v1/groups/1/fiches/4.


2 The second line and the following ones, if any, represent the body of the request (applicable for POST and PUT requests only).

URL for the production environment

The base URL is :

https://www.clicrdv.com/

Important Please note the use of https:// in the URL above. All ClicRDV API communication is encrypted over HTTPS. Any non-secure requests are automatically rejected

URL for the test/sandbox environment

If your use case requires a write access to the API, it is recommended to use the sandbox environment.

The base URL becomes :

https://sandbox.clicrdv.com/

Important The sandbox and production API keys, are different.

Output Format

The API can deliver data in : json, xml ou csv.

The ouput format is specified using the format parameter, or by adding an extension to the path. Examples:

GET https://www.clicrdv.com/api/v1/groups/:group_id/fiches.json

or equivalently:

GET https://www.clicrdv.com/api/v1/groups/:group_id/fiches?format=json

Important The CSV format is availaible for read only, and :

Input Format / Content-Type

Important All write requests (POST requests), must provide the Content-Type HTTP header, indicating the format of the data in the request body.

  • application/json
  • application/x-www-form-urlencoded
  • application/xml