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 "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

Parameter	Type	Required	Description
id	string	true	Event identifier
type	string	true	Event type
data	transport.EventData	true	Event data
enterpriseid	string	true	For which keyloop enterprise this event is for
storeid	string	true	For which keyloop store this event is for

Response schema

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

Models and Enumeration

EventData Model

Field	Type	Description
RepairOrderID	string	For which keyloop RepairOrder this event is for

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:

Error Code	Meaning
400	Bad Request : Your request is invalid.
401	Unauthorized : Your API key is wrong.
404	Not Found : The specified endpoint could not be found.
405	Method Not Allowed : You tried to access server with an invalid method.
429	Too Many Requests : You're making too many requests.
500	Internal Server Error : We had a problem with our server. Try again later.
503	Service Unavailable : We're temporarily offline for maintenance. Please try again later.