Skip to content

Commit c6fcf58

Browse files
authored
Merge pull request #92 from connectedcars/leasin
Adds ConnectedLeasing to integration docs
2 parents fffce26 + 369081c commit c6fcf58

File tree

4 files changed

+15
-5
lines changed

4 files changed

+15
-5
lines changed

integrations/booking-import.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Service bookings can be pushed to Connected Cars when they are added, changed or
55

66
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).
77

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

1111
## Field descriptions
1212
| Key | Type | Example | Notes |

integrations/intro.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# Integrations
22

3+
## Integrations for ConnectedWorkshop
4+
35
* [Prefill via vehicle lookup](./integrations/vehicle-lookup.md) (alternatively [via redirect to ConnectedWorkshop](./workshop.md))
46
* [Deregistration on change of ownership](./integrations/ownership-change.md)
57
* [Autofill form for online service booking](./integrations/booking-autofill.md)
68
* [Show news feed in app](./integrations/news-api.md)
79
* [Show video feed in app](./integrations/videos-api.md)
810
* [Import service bookings](./integrations/booking-import.md)
911
* [Generic integrations via pull API](./integrations/pull-api.md)
12+
13+
## Integrations for ConnectedLeasing
14+
15+
* [Prefill via vehicle lookup](./integrations/vehicle-lookup.md) (alternatively [via redirect to ConnectedLeasing](./workshop.md))
16+
* [Deregistration on change of ownership](./integrations/ownership-change.md)
17+
* [Import service bookings](./integrations/booking-import.md)
18+
* [Generic integrations via pull API](./integrations/pull-api.md)
19+

integrations/pull-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[Go back to Integrations](./integrations/intro)
22

33
# Generic integrations via pull API
4-
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).
4+
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).
55

66
## Starting with the API explorer
77
1. Go to https://api.connectedcars.io/graphql/graphiql

integrations/vehicle-lookup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[Go back to Integrations](./integrations/intro)
22

33
# Prefill via vehicle lookup
4-
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.
4+
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.
55

6-
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.
6+
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.
77

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

0 commit comments

Comments
 (0)