Introduction

Welcome to the Claire Automotive Support Public API !

You can use our API to access Claire API endpoints, which gives information on various sections from our database.

Endpoints description, method, url, request/response shema and their description are presented on the left. The right side contains example requests (via curl) and reponses (in JSON).

For more information on types and possible value, refer to the Models and Enumeration section.

In the future, more endpoints will be added in order to provide complete access to Claire database.

If this is your first time reading the docs, check out the Authentication section for obtaining and using API keys.

Changelog section contains all updates related to this API.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: $your_api_key"

# Alternatively, you can place the api_key as a query parameter:
curl "api_endpoint_here?api_key=$your_api_key"

Make sure to replace your_api_key with your actual API key.

Claire Automotive Support API uses API keys to allow access to the API.. You can register a new API key only as a Dealer Admin, inside Claire application, on the API Keys section.

Currently you can create as many API Keys as you want and give them a name. Once you don't want to use it you can disable it from the dashboard.

Claire API expects the API key to be included in all API requests to the server. There are two ways to include it in requests:

• As a query parameter: ?api_key=&your_api_key

• As a header: Authorization: &your_api_key

Appointments

This controller provides endpoints to get the appointment details.

PublicAccount can get the appointments by the DMSNr and also get the appointment details by the appointment ID.

[DEPRECATED: Use /appointments/list] Get Appointments by DMS number

curl "API_BASE/v1/appointments?location_id=...&dms_nr=...&customer_kind=..."
    -H "Authorization: $your_api_key"

[DEPRECATED: Use /appointments/list] This endpoint retrieves Appointments by the provided DMS Number. If the DMS number is of customer type, customer_kind query parameter needs to be provided as well.

HTTP Request

GET /v1/appointments?location_id=...&dms_nr=...&customer_kind=...

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "dms_number": "",
        "workorder_number": "",
        "reference_number": "",
        "importer_version": "",
        "dms_status": "",
        "car_check_started": false,
        "customer_waiting": false,
        "is_local": false,
        "is_money": false,
        "is_star": false,
        "is_star_color": "",
        "is_shop": false,
        "is_shop_color": "",
        "is_lease_company": false,
        "has_extra_check": false,
        "final_check_has_remarks": false,
        "is_recurring": false,
        "warranty_pin_count": 0,
        "warranty_pin_signature_missing_count": 0,
        "warranty_pin_claim_nr_missing_count": 0,
        "warranty_pin_support_nr_missing_count": 0,
        "recall_pin_count": 0,
        "recall_pin_claim_nr_missing_count": 0,
        "recall_pin_support_nr_missing_count": 0,
        "remark_pin_count": 0,
        "next_date": null,
        "predicted_next_date": null,
        "time_car_app": "0001-01-01T00:00:00Z",
        "is_pinned": false,
        "is_pinned_manually": false,
        "status_override": 0,
        "scheduled_in": null,
        "scheduled_out": null,
        "key_dropped_at": null,
        "key_dropped_in": null,
        "key_picked_up_at": null,
        "key_picked_up_by_id": null,
        "key_dropped_back_at": null,
        "key_dropped_back_by_id": null,
        "key_dropped_back_in": null,
        "key_picked_up_back_at": null,
        "key_picked_up_back_by_id": null,
        "driver_id": null,
        "owner_id": null,
        "contract_id": null,
        "location_id": 0,
        "car_id": 0,
        "vin": "",
        "car_model": "",
        "car_make": "",
        "license_plate_number": "",
        "current_km": 0,
        "dms_km": 0,
        "next_km": 0,
        "car_apk_date": null,
        "car_hu_date": null,
        "driver_initials": "",
        "driver_title": "",
        "driver_firstname": "",
        "driver_surname": "",
        "contractor_initials": "",
        "contractor_title": "",
        "contractor_firstname": "",
        "contractor_surname": "",
        "owner_initials": "",
        "owner_title": "",
        "owner_firstname": "",
        "owner_surname": "",
        "company": "",
        "appointment_status_identifier": 0,
        "last_update": null,
        "last_user": "",
        "last_user_profile_picture": "",
        "last_user_at": null,
        "approved_not_fixed_count": 0,
        "customer_driver": null,
        "customer_owner": null,
        "customer_contract": null,
        "check_initiator": null,
        "car": null,
        "car_profile_picture": null,
        "final_check_images": null,
        "final_check_videos": null,
        "status_history": null,
        "interventions": null,
        "customcom_key": null,
        "appointment_status_name": "",
        "checklists": null,
        "dealer_name": "",
        "dealer_commercial_name": "",
        "location_name": "",
        "location_phone": "",
        "driver_dms_number": null,
        "owner_dms_number": null,
        "contract_dms_number": null,
        "car_dms_number": null,
        "dms_location_source": null
    }
]

Request schema

Response schema

This endpoint return an array of Appointment, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Get Appointments by provided filters

curl "API_BASE/v1/appointments/list"
    -H "Authorization: $your_api_key"

This endpoint retrieves Appointments through the provided filters. At least one filter must be used.

HTTP Request

POST /v1/appointments/list

The request Body payload is:

{
    "location_id": 0,
    "dms_nr": null,
    "customer_kind": null,
    "date": null,
    "is_pinned": null
}

The request JSON response is:

{
    "appointments": null
}

Request schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Get a Specific Appointment

curl "API_BASE/v1/appointments/{id}"
    -H "Authorization: $your_api_key"

This endpoint retrieves a specific Appointment by the provided Claire Appointment ID.

HTTP Request

GET /v1/appointments/{id}

The request JSON response is:

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "dms_number": "",
    "workorder_number": "",
    "reference_number": "",
    "importer_version": "",
    "dms_status": "",
    "car_check_started": false,
    "customer_waiting": false,
    "is_local": false,
    "is_money": false,
    "is_star": false,
    "is_star_color": "",
    "is_shop": false,
    "is_shop_color": "",
    "is_lease_company": false,
    "has_extra_check": false,
    "final_check_has_remarks": false,
    "is_recurring": false,
    "warranty_pin_count": 0,
    "warranty_pin_signature_missing_count": 0,
    "warranty_pin_claim_nr_missing_count": 0,
    "warranty_pin_support_nr_missing_count": 0,
    "recall_pin_count": 0,
    "recall_pin_claim_nr_missing_count": 0,
    "recall_pin_support_nr_missing_count": 0,
    "remark_pin_count": 0,
    "next_date": null,
    "predicted_next_date": null,
    "time_car_app": "0001-01-01T00:00:00Z",
    "is_pinned": false,
    "is_pinned_manually": false,
    "status_override": 0,
    "scheduled_in": null,
    "scheduled_out": null,
    "key_dropped_at": null,
    "key_dropped_in": null,
    "key_picked_up_at": null,
    "key_picked_up_by_id": null,
    "key_dropped_back_at": null,
    "key_dropped_back_by_id": null,
    "key_dropped_back_in": null,
    "key_picked_up_back_at": null,
    "key_picked_up_back_by_id": null,
    "driver_id": null,
    "owner_id": null,
    "contract_id": null,
    "location_id": 0,
    "car_id": 0,
    "vin": "",
    "car_model": "",
    "car_make": "",
    "license_plate_number": "",
    "current_km": 0,
    "dms_km": 0,
    "next_km": 0,
    "car_apk_date": null,
    "car_hu_date": null,
    "driver_initials": "",
    "driver_title": "",
    "driver_firstname": "",
    "driver_surname": "",
    "contractor_initials": "",
    "contractor_title": "",
    "contractor_firstname": "",
    "contractor_surname": "",
    "owner_initials": "",
    "owner_title": "",
    "owner_firstname": "",
    "owner_surname": "",
    "company": "",
    "appointment_status_identifier": 0,
    "last_update": null,
    "last_user": "",
    "last_user_profile_picture": "",
    "last_user_at": null,
    "approved_not_fixed_count": 0,
    "customer_driver": null,
    "customer_owner": null,
    "customer_contract": null,
    "check_initiator": null,
    "car": null,
    "car_profile_picture": null,
    "final_check_images": null,
    "final_check_videos": null,
    "status_history": null,
    "interventions": null,
    "customcom_key": null,
    "appointment_status_name": "",
    "checklists": null,
    "dealer_name": "",
    "dealer_commercial_name": "",
    "location_name": "",
    "location_phone": "",
    "driver_dms_number": null,
    "owner_dms_number": null,
    "contract_dms_number": null,
    "car_dms_number": null,
    "dms_location_source": null
}

Request schema

Response schema

This endpoint return an object of type Appointment, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Import Appointments

curl "API_BASE/v1/appointments/import"
    -H "Authorization: $your_api_key"

This endpoint allow you to create/update batches of Appointment within Claire.

One request must - not contain more than 100 appointments - not contain appointments from different locations

The location must - be within the scope of the API key used - not be connected to an API based DMS (Ex: Keyloop, NextLane, Autoflex, etc...)

Each appointment must - have a dms_nr, wo_nr, dms_created_at, time_car_app and location_id - have a car with a dms_nr, vin, model and make - have at least one customer with a dms_nr and surname - if provided, interventions must have a dms_nr and a title

This endpoint will add the appointment(s) to the dealer's queue for processing.

The result of each appointment import from the dealer's queue can be received in real time by webhook, if set-up (optional).

Setting up this webhook is achieved by creating a webhook for the trigger PublicAPIAppointmentImported, either for the location or for the dealer (doable through our dashboard or through this API if you were given the rights to). This webhook payload will always contain: - webhook_trigger_id set to the value of PublicAPIAppointmentImported ( see WebhookTriggerID Enumeration in the Models & Enumeration section ) (helpful if you want to handle multiple type of webhook triggers with one handler. - dealer_id, dealer_location_id, wo_nr This webhook payload will also contain the appointment_id on success, or appointment_import_error on failure.

It's important to note that the dms_nr and dms_created_at are used to identify what actions will be taken to import appointments and customers (not cars, see below). - If a dms_nr already exists for the given dms_created_at within Claire for the given location, the object will be updated. - If a dms_nr does not exist for the given dms_created_at within Claire for the given location, the object will be created. - If your DMS reuse the dms_nr, you must make sure to specify a different dms_created_on to differentiate them.

Cars are imported at the dealer level, not at the location level, and the vin is used to differentiate them.

All import related websocket and webhook events will be pushed to users as when Claire normally pull data from a DMS.

Note that this endpoint will return HTTP 200 OK even if some appointment(s) failed to be validated, queued or imported. If you want to know if a given appointment was imported successfully or not, you must set up the PublicAPIAppointmentImported webhook trigger.

HTTP Request

POST /v1/appointments/import

The request Body payload is:

{
    "appointments": null
}

The request JSON response is:

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Checks

This controller provides endpoints to retrieve the checks belonging to specific appointment.

To get the checks for a specific appointment, appointment ID needs to be provided.

Get Checks of a Specific Appointment

curl "API_BASE/v1/checks?appointment_id=..."
    -H "Authorization: $your_api_key"

This endpoint retrieves Checks of a specific Appointment by the provided Appointment ID.

HTTP Request

GET /v1/checks?appointment_id=...

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "duration": 0,
        "appointment_id": 0,
        "car_id": 0,
        "intervention_id": null,
        "mechanic": null,
        "checklist": null,
        "receptionist": null,
        "question_items": null
    }
]

Request schema

Response schema

This endpoint return an array of Check, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Locations

This controller provides endpoints to retrieve the locations.

The locations are provided as a list and only those locations are provided which belongs to the dealer ID of the public account.

Get All Locations

curl "API_BASE/v1/locations"
    -H "Authorization: $your_api_key"

This endpoint retrieves all Locations.

HTTP Request

GET /v1/locations

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "NotifierKey": "",
        "dms_location_source": "",
        "name": "",
        "commercial_name": "",
        "headline": "",
        "footerline": "",
        "logo": "",
        "company_stamp": "",
        "street": "",
        "postal_code": "",
        "city": "",
        "country": "",
        "phone_nr": "",
        "DeskCheckInEnabled": false,
        "IsOpenDeskCheckoutOnCarOutOfShopEnabled": false,
        "IsKeyloopEventEnabled": false,
        "IsShareboxEnabled": false,
        "DMSLocationIDs": ""
    }
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an array of DealerLocation, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Tags

This controller provides endpoint to retrieves all the tags.

Get Tags

curl "API_BASE/v1/tags"
    -H "Authorization: $your_api_key"

This endpoint retrieves all the tags.

HTTP Request

GET /v1/tags

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "name": "",
        "color": "",
        "system": false
    }
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an array of Tag, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Questions

This controller provides the endpoints to retrieve the question details.

This controller returns all the default questions and also the dealer questions.

Get Questions

curl "API_BASE/v1/questions"
    -H "Authorization: $your_api_key"

This endpoint retrieves all the default questions plus the dealer questions.

HTTP Request

GET /v1/questions

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "question": "",
        "role_id": 0,
        "question_elements": null
    }
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an array of Question, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Car

This controller provides endpoints to retrieve the Car details.

The car details is provided based on the VIN of the Car at the dealer locations.

Get a car by VIN

curl "API_BASE/v1/car?vin=..."
    -H "Authorization: $your_api_key"

This endpoint search if a car exists with the given VIN in the dealer locations

HTTP Request

GET /v1/car?vin=...

The request JSON response is:

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "is_truck": false,
    "make": "",
    "model": "",
    "fuel": "",
    "reg_number": "",
    "vin": "",
    "dms_number": "",
    "picture": "",
    "dms_registration": null,
    "rdw_first_registration": null,
    "rdw_first_registration_nl": null,
    "rdw_type_goedkeurings_nummer": "",
    "rdw_type": "",
    "rdw_variant": "",
    "rdw_uitvoering": "",
    "apk_date_dms": null,
    "hu_date_dms": null,
    "warranty_date_start": null,
    "warranty_date_end": null,
    "rob_lease_expiration": null,
    "mcc_status": null,
    "mcc_status_time": null,
    "tyres_on_car": null,
    "tyres_in_storage": null,
    "truck_tyres": null,
    "notes": null
}

Request schema

Response schema

This endpoint return an object of type Car, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Webhooks

Webhooks allows to setup up triggers in Claire to be notified whenever a specific change or action has been made, or when something is available.

This feature is useful to fetch new appointment data from our Public API as soon as it has been updated.

There are two ways to create a webhook.

Claire Dashboard

1. Login to Claire as Dealer Admin (minimum role required to see the webhook page)
2. In the main menu, choose Webhooks
3. Click on the plus button in bottom-right corner
4. Fill in the form accordingly i.e.
   • provide a name to the webhook
   • select Location (optional, if provided will be triggered only for the given location, otherwise it will be triggered for all locations of the selected Dealer)
   • choose the trigger from the drop down
   • provide an url which will be called by the webhook
   • add necessary headers if required

Public API

To use this method, an API key is required, it can be created in the Claire dashboard

1. Login to Claire as Dealer Admin (minimum role required to see the API page) 2. In the main menu, choose Claire API 3. Click on Create API Key and enter the required fields 4. In the list you can now click on Show the API key, for the row that you just created

Contact support if needed to create an API key.

See the Create a webhook section below for more details on how to create a webhook with this API.

Whitelisting

If you have a firewall or if you want to restrict who can call the URLs defined in your webhooks, use the the following IP addresses:

• Production: 34.91.154.69
• Development: 34.91.177.194

Payload

A json object will be passed as body of the POST request made to your webhooks URLs, with the following fields:

Get the list of existing webhooks

curl "API_BASE/v1/webhooks/list"
    -H "Authorization: $your_api_key"

This endpoint returns the list of webhooks created with the api key used as authentication

HTTP Request

GET /v1/webhooks/list

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "name": "",
        "webhook_trigger_id": 0,
        "dealer_id": 0,
        "dealer_location_id": null,
        "public_account_id": null,
        "user_id": null,
        "url": "",
        "queued": false,
        "checklist_id": null,
        "active": false,
        "headers": null,
        "public_account": null,
        "user": null,
        "has_recent_error": null
    }
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an array of Webhook, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Create a webhook

curl "API_BASE/v1/webhooks/create"
    -H "Authorization: $your_api_key"

This endpoint create a webhook that will call the given URL, every time the given trigger occurs. The URL can be called with optional headers, if given. A JSON object with three fields is passed as POST payload to the URL called - Claire Appointment ID (appointment_id) - Claire DealerLocation ID (dealer_location_id) - WorkOrder Number (wo_nr). You have a limit of webhooks per API key that can be created, contact support if you reach it.

HTTP Request

POST /v1/webhooks/create

The request Body payload is:

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "name": "",
    "webhook_trigger_id": 0,
    "dealer_id": 0,
    "dealer_location_id": null,
    "public_account_id": null,
    "user_id": null,
    "url": "",
    "queued": false,
    "checklist_id": null,
    "active": false,
    "headers": null,
    "public_account": null,
    "user": null,
    "has_recent_error": null
}

The request JSON response is:

{
    "ID": 0
}

Request schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Get a webhook details

curl "API_BASE/v1/webhooks/view?webhook_id=..."
    -H "Authorization: $your_api_key"

This endpoint returns the webhook details, including optional headers if any, for the webhook ID provided

HTTP Request

GET /v1/webhooks/view?webhook_id=...

The request JSON response is:

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "name": "",
    "webhook_trigger_id": 0,
    "dealer_id": 0,
    "dealer_location_id": null,
    "public_account_id": null,
    "user_id": null,
    "url": "",
    "queued": false,
    "checklist_id": null,
    "active": false,
    "headers": null,
    "public_account": null,
    "user": null,
    "has_recent_error": null
}

Request schema

Response schema

This endpoint return an object of type Webhook, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Update a webhook

curl "API_BASE/v1/webhooks/update"
    -H "Authorization: $your_api_key"

This endpoint updates a webhook that was created with the same API key, for the same dealer, based on the webhook ID given. Headers are replaced, so make sure to provide them if you do not intend to remove them.

HTTP Request

POST /v1/webhooks/update

The request Body payload is:

{
    "created_on": "0001-01-01T00:00:00Z",
    "updated_on": "0001-01-01T00:00:00Z",
    "id": 0,
    "name": "",
    "webhook_trigger_id": 0,
    "dealer_id": 0,
    "dealer_location_id": null,
    "public_account_id": null,
    "user_id": null,
    "url": "",
    "queued": false,
    "checklist_id": null,
    "active": false,
    "headers": null,
    "public_account": null,
    "user": null,
    "has_recent_error": null
}

The request JSON response is:

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Delete a webhook

curl "API_BASE/v1/webhooks/delete?webhook_id=..."
    -H "Authorization: $your_api_key"

This endpoint deletes the webhook for the provided webhook ID if it was created with the same API key, for the same dealer.

HTTP Request

POST /v1/webhooks/delete?webhook_id=...

The request JSON response is:

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Response schema

This endpoint do not return anything, only the HTTP status code matters.

Test a webhook

curl "API_BASE/v1/webhooks/test"
    -H "Authorization: $your_api_key"

This endpoint triggers the webhook for the provided webhook ID if it was created with the same API key, for the same dealer.

HTTP Request

POST /v1/webhooks/test

The request Body payload is:

{
    "WebhookID": 0,
    "CommunicationReceiverID": null,
    "Payload": {
        "WebhookTriggerID": 0,
        "AppointmentID": 0,
        "DealerID": 0,
        "DealerLocationID": 0,
        "WONr": "",
        "CommunicationKey": null,
        "CustomerDMSNr": null,
        "CustomerType": null,
        "ReceptionistName": null,
        "ReceptionistPhone": null,
        "ReceptionistProfilePictureURL": null,
        "CustomerRemarks": null,
        "CorrectPhone": null,
        "CorrectEmail": null,
        "CustomerName": null,
        "LocationVAT": null,
        "ScheduledInterventions": null,
        "CustomerOrder": null,
        "CustomerContactItems": null,
        "DMSLocationSource": "",
        "IsShop": null,
        "IsShopColor": null,
        "ChecklistID": null,
        "ChecklistName": null,
        "DMSNr": null,
        "AppointmentImportError": null
    }
}

The request JSON response is:

This endpoint do not return anything, only the HTTP status code matters.

Request schema

Response schema

This endpoint do not return anything, only the HTTP status code matters.

List webhook errors

curl "API_BASE/v1/webhooks/list_errors"
    -H "Authorization: $your_api_key"

This endpoint returns a paginated list of errors that have occurred for a webhook. It is limited to the past 3 months.

HTTP Request

POST /v1/webhooks/list_errors

The request Body payload is:

{
    "WebhookID": 0,
    "Page": 0
}

The request JSON response is:

{
    "items": null,
    "nb_pages": 0
}

Request schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Get the list of triggers

curl "API_BASE/v1/webhooks/list_triggers"
    -H "Authorization: $your_api_key"

This endpoint returns the list of all the triggers that can be used to create a webhook

HTTP Request

GET /v1/webhooks/list_triggers

The request JSON response is:

[
    {
        "created_on": "0001-01-01T00:00:00Z",
        "updated_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "name": "",
        "description": ""
    }
]

Request schema

This request does not accept any parameters.

Response schema

This endpoint return an array of WebhookTrigger, please refer to the JSON response column on the right, or to the Models and Enumeration section for more details.

Models and Enumeration

CommunicationChannelID Enumeration

InterventionElementStatus Enumeration

InterventionElementType Enumeration

MCCStatus Enumeration

QuestionElementTemplate Enumeration

QuestionResultStatus Enumeration

RoleID Enumeration

Season Enumeration

SnoozeDepartmentID Enumeration

SnoozeStatusID Enumeration

SnoozeTypeID Enumeration

StatusIdentifier Enumeration

StatusOverride Enumeration

TyreLocation Enumeration

TyrePosition Enumeration

WebhookTriggerID Enumeration

Appointment Model

AppointmentStatusHistory Model

Car Model

CarNote Model

CarTyres Model

Check Model

Checklist Model

Customer Model

DealerLocation Model

FinalCheckImage Model

FinalCheckVideo Model

Intervention Model

InterventionAttachment Model

InterventionElement Model

PublicAccount Model

Question Model

QuestionElement Model

QuestionResult Model

Snooze Model

Tag Model

TruckTyres Model

Tyre Model

TyreReplacement Model

User Model

Webhook Model

WebhookError Model

WebhookHeader Model

WebhookTrigger Model

Changelog

This section contains changes related to the Claire API. Changes will be included if:

• A new endpoint is added
• A new field is added to an existing endpoint
• Field description changes
• A field is deprecated

Initial release - 01.02.2019.

The following endpoints are included with initial release:

• /appointments/{id}
• /appointments/?customer_kind={kind}&dms_nr={dms_nr}&location_id={location_id}
• /checks?appointment_id={appID}
• /locations

Model updates - 05.06.2019.

Various models were updated. Most notable change is that id changed from string to integer.

Multiple updates - 02.12.2019.

Following changes have been made:

1 On the /checks endpoint, inside question_items object, field answer instead of single answer, answer now contains multiple answers. The field is now of type array and renamed to answers. 2 Second change on the /checks endpoint is the snooze_info object, inside question_items object. Instead of a single object with fields title, note, type, these are all now separate fields, as following: snooze_title, snooze_note, snooze_type. 3 Following fields are depracated: Appointment object: car_fleet_number User object: last_login Car object: fleet_number, fleet_identifier Intervention object: section

Webhooks - 01.03.2021.

Webhooks allows you to setup triggers in Claire which can be used to notify you when a change is made on appointment. This feature is useful if you want to fetch new appointment data from PublicAPI as soon as it's updated.

To setup the webhooks follow this process:

1 Login to Claire 2 Click on "Webhooks" menu 3 Click on a "plus" button in bottom-right corner 4 Fill the form accordingly

Currently we support these triggers:

• Check created: Triggered when a check is created
• Offer ready: Triggered when an offer is ready
• Customer OK: Triggered when a customer is OK with the offer
• Car ready: Triggered when a car is ready
• Quality check: Triggered when a quality check is created

Automated Documentation - 01.04.2021

This documentation is now auto generated, a lot more details are available in each endpoint description and in the new Model and Enumeration section.

Two new endpoints /tags and questions have been added to retrieve the list of possible values related to question result's tags and questions.

Tyres information have been added at the Car and QuestionResult levels.

Import Appointment - 14.08.2023

New endpoint /appointments/import has been added to create and update appointments in claire. Refer to the relevant documentation for more details on how to use this.

List Appointments - 23-07-2024

New endpoint /appointments/list has been added to query for appointments using a filtering engine.

The endpoint /appointments is now deprecated and is being planned for removal. It will no longer be supported.

Customer communication

If a communication was sent to the customer (Online check-in, Diagnose overview, Repair overview) the Appointment contain a key in the customcom_key field.

This key is valid to open the communication in read only mode, as the receptionist do.

To open a communication from a key, use the following URL: https://mycarcheck.pro/#!/{customcom_key} by replacing the key value.

Errors

The Claire Automotive Support API uses the following error codes:

Rate Limiting

All Claire APIs have rate limiting implemented. A single API key can make up to 10.800 requests per hour. After reaching the rate limit, HTTP Status 429 - Too Many Requests, will be returned.

Response headers contain rate-limiting details:

• X-RateLimit-Limit: Number of requests you can make in an hour
• X-RateLimit-Remaining: Number of requests left for the time window
• X-RateLimit-Reset: The remaining window before the rate limit resets in UTC epoch seconds

Currently there is no rate limiting per dealer, but it may be introduced in future updates.