Introduction

The keyloop API Service is a RESTful web service that allows clients to search the Keyloop API and retrieve results based on the specified endpoint.

Authentication

This service requires a Claire User Session and is expected to only be called through the Dashboard

Event

Handler for keyloop events

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

When a RepairOrderID is received from the repair-order event, this endpoint will fetch the RepairOrder and will either update or insert as an appointment.

HTTP Request

POST /v1/events/handler

The request Body payload is:

{
    "id": "",
    "type": "",
    "data": {
        "RepairOrderId": ""
    },
    "enterpriseid": "",
    "storeid": ""
}

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.

Models and Enumeration

Schemas

The types below are used in the request and response bodies of the endpoints above but are not database models. Their fields are described here for reference.

EventData

Changelog

This section contains changes related to the Keyloop 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 - 24.02.2023.

The following endpoints are included with initial release:

• /v1/appointments/search
• /v1/appointments/refresh
• /v1/vehicle/search
• /v1/vehicle/customers
• /v1/customers/search
• /v1/customers/view

Errors

The Claire Automotive Support APIs uses the following error codes: