Places API

The Places API let's you search inside Clinia data. Places are defined within this API as healthcare facilities.

Introduction to the API

The following place requests are available:

  • Place Search returns a list of places based on a user's location or query
  • Place Match returns the best match based on data coming from other sources

Comming soon

  • Place Details returns more detailed information about a specific place

Hosts

The REST API lets your interact directly with Clinia from anything that can send an HTTP request. All API access must use HTTPS. The primary host is https://api.clinia.ca.

Format

The entire API uses JSON encoded as UTF-8.

The body of POST and PUT requests must be either a JSON object or a JSON array (depending on the particular endpoint) and their Content-Type header should be set to application/json; charset=UTF-8.

The body of responses is always a JSON object, and their content type is always application/json; charset=UTF-8.

Authentication

The API uses API Keys to authenticate requests. Authentication is done via HTTP headers:

  • X-Clinia-API-Key authenticates the endpoint.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

For javascript usage, Cross-origin Resource Sharing (CORS) is supported by the API so that you can use XMLHttpRequest.