Introduction

Welcome to the Claire ACSES API !

Endpoints method, url, request/response schema 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.

If this is your first time reading the docs, check out the Authentication section.

The changelog section contains all updates related to this API.

Event

List webhook history

curl "API_BASE/v1/events/history"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Webhook events are logged by acses, this endpoint returns the full history

HTTP Request

POST /v1/events/history

The request Body payload is:

{
    "dealer_location_id": 0
}

The request JSON response is:

{
    "history": []
}

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.

Handles events from acses

curl "API_BASE/v1/events/handler"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Webhooks events are posted by acses, this endpoint process the events and update the appointment in the Claire

HTTP Request

POST /v1/events/handler

The request Body payload is:

{
    "tablekey": "",
    "lockersystem": "",
    "cellnumber": "",
    "eventName": "",
    "eventDate": "0001-01-01T00:00:00Z",
    "booking": {
        "tablekey": "",
        "name": "",
        "tag": "",
        "state": "",
        "startDate": "0001-01-01T00:00:00Z",
        "endDate": "0001-01-01T00:00:00Z",
        "code": "",
        "create": "0001-01-01T00:00:00Z",
        "lastaction": "",
        "lockercell": "",
        "lockercellTablekey": "",
        "objectTablekey": "",
        "siteTablekey": ""
    }
}

The request JSON response is:

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

Request schema

Response schema

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

Simulate opening the door

curl "API_BASE/v1/events/simulate?location_id=...&locker_system_id=...&code=...&action=..."
    -H "Authorization: Bearer $token"

In dev only, this endpoints allows to simulate opening the door to drop or pick a key

HTTP Request

GET /v1/events/simulate?location_id=...&locker_system_id=...&code=...&action=...

The request JSON response is:

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

Request schema

Response schema

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

Employee Controller

Allows a user to interact with ACSES lockers

Allows a user to pickup, dropback and assist the customer with picking up keys from ACSES lockers.

Whenever you want to open a door with a PIN code that you received, you have to open this link (once)

https://clairedev.nl/api/acses/v1/events/simulate?location_id=82&locker_system_id=151&code={PIN_CODE}&action={ACTION}

And replace PIN_CODE with the pin code you received and ACTION with either dropoff when dropping a key or checkout when you're picking up a key.

The location_id is the claire dev location_id for Visser Werplaats where we have the ACSES locker setup.

The locker_system_id is the id of the locker in ACSES system (we have only one).

List available lockers

curl "API_BASE/v1/employees/list_available_lockers"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Return the list of available lockers for the given location ID

HTTP Request

POST /v1/employees/list_available_lockers

The request Body payload is:

{
    "dealer_location_id": 0
}

The request JSON response is:

{
    "lockers": []
}

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.

Pickup

curl "API_BASE/v1/employees/pickup"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Return the PIN for the locker to pickup the keys

HTTP Request

POST /v1/employees/pickup

The request Body payload is:

{
    "appointment_id": 0
}

The request JSON response is:

{
    "acses_pin": 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.

Assist Pickup

curl "API_BASE/v1/employees/assist_pickup"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Returns the PIN of the locker for assisted pick up of keys

HTTP Request

POST /v1/employees/assist_pickup

The request Body payload is:

{
    "appointment_id": 0
}

The request JSON response is:

{
    "acses_pin": 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.

Dropback

curl "API_BASE/v1/employees/drop_back"
    -H "Authorization: Bearer $token"
    -H "Content-Type: application/json"

Returns the PIN of the locker for dropping back the keys

HTTP Request

POST /v1/employees/drop_back

The request Body payload is:

{
    "locker_system_id": "",
    "appointment_id": 0,
    "appointment_note_id": null
}

The request JSON response is:

{
    "acses_pin": 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.

Models and Enumeration

BookingState Enumeration

ObjectStatus Enumeration

Booking Model

LockerSystem Model

WebhookEvent Model

WebhookHistory Model

Changelog

This section contains changes related to the ACSES service. 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 - 29.03.2024.

The following endpoints are included with initial release:

• /v1/events/history
• /v1/events/handler

Errors

The Claire Automotive Support APIs uses the following error codes: