Skip to content

Commit

Permalink
Merge pull request #92 from connectedcars/leasin
Browse files Browse the repository at this point in the history
Adds ConnectedLeasing to integration docs
  • Loading branch information
mex authored Jul 4, 2024
2 parents fffce26 + 369081c commit c6fcf58
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 5 deletions.
4 changes: 2 additions & 2 deletions integrations/booking-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Service bookings can be pushed to Connected Cars when they are added, changed or

The import of service bookings uses the standard GraphQL pull API via the `addBookings`, `changeBookings` and `cancelBookings` mutations. Descriptions of the fields and example requests can be found below. Further details on working with the pull API can be found on [the dedicated page](./integrations/pull-api).

_Screenshot of booking data show in ConnectedWorkshop_
![Booking data show in ConnectedWorkshop](./booking-import-screenshot.png)
_Screenshot of booking data show in ConnectedWorkshop/ConnectedLeasing_
![Booking data show in ConnectedWorkshop/ConnectedLeasing](./booking-import-screenshot.png)

## Field descriptions
| Key | Type | Example | Notes |
Expand Down
10 changes: 10 additions & 0 deletions integrations/intro.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
# Integrations

## Integrations for ConnectedWorkshop

* [Prefill via vehicle lookup](./integrations/vehicle-lookup.md) (alternatively [via redirect to ConnectedWorkshop](./workshop.md))
* [Deregistration on change of ownership](./integrations/ownership-change.md)
* [Autofill form for online service booking](./integrations/booking-autofill.md)
* [Show news feed in app](./integrations/news-api.md)
* [Show video feed in app](./integrations/videos-api.md)
* [Import service bookings](./integrations/booking-import.md)
* [Generic integrations via pull API](./integrations/pull-api.md)

## Integrations for ConnectedLeasing

* [Prefill via vehicle lookup](./integrations/vehicle-lookup.md) (alternatively [via redirect to ConnectedLeasing](./workshop.md))
* [Deregistration on change of ownership](./integrations/ownership-change.md)
* [Import service bookings](./integrations/booking-import.md)
* [Generic integrations via pull API](./integrations/pull-api.md)

2 changes: 1 addition & 1 deletion integrations/pull-api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[Go back to Integrations](./integrations/intro)

# Generic integrations via pull API
The pull API is using [GraphQL](https://graphql.org/learn/). This API can be used for a wide range of integrations as this API is powering ConnectedWorkshop, ConnectedFleet and MyConnectedCar. The pull API relies on the [Auth API](./auth-api) for creating users and authenticating requests (via short-living JWT).
The pull API is using [GraphQL](https://graphql.org/learn/). This API can be used for a wide range of integrations as this API is powering ConnectedWorkshop, ConnectedLeasing, ConnectedFleet and MyConnectedCar. The pull API relies on the [Auth API](./auth-api) for creating users and authenticating requests (via short-living JWT).

## Starting with the API explorer
1. Go to https://api.connectedcars.io/graphql/graphiql
Expand Down
4 changes: 2 additions & 2 deletions integrations/vehicle-lookup.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[Go back to Integrations](./integrations/intro)

# Prefill via vehicle lookup
When the users of ConnectedWorkshop creates a vehicle, they enter the VIN or license plate and the system then uses that to look up vehicle details from an endpoint you make available. The vehicle details needed are listed below and should be retrieved from either the manufacturer or the national vehicle registry.
When the users of ConnectedWorkshop/ConnectedLeasing creates a vehicle, they enter the VIN or license plate and the system then uses that to look up vehicle details from an endpoint you make available. The vehicle details needed are listed below and should be retrieved from either the manufacturer or the national vehicle registry.

The endpoint should be available via HTTPS and can require authentication via a symmetric key (like an API key listed in the example below). The endpoint must accept both VIN and license plate as input (query parameters) and one of them should be required. If a vehicle is found, the endpoint must return a JSON response with a 200 status code. If a vehicle is not found, the endpoint must return a 404 status code. The endpoint should respond within 2 seconds to ensure a satisfactory user experience for the workshop employees working in ConnectedWorkshop.
The endpoint should be available via HTTPS and can require authentication via a symmetric key (like an API key listed in the example below). The endpoint must accept both VIN and license plate as input (query parameters) and one of them should be required. If a vehicle is found, the endpoint must return a JSON response with a 200 status code. If a vehicle is not found, the endpoint must return a 404 status code. The endpoint should respond within 2 seconds to ensure a satisfactory user experience for the workshop employees working in ConnectedWorkshop/ConnectedLeasing.

Once the endpoint is ready, provide Connected Cars with the details. Connected Cars will then implement the prefill based on the provided endpoint.

Expand Down

0 comments on commit c6fcf58

Please sign in to comment.