-
Notifications
You must be signed in to change notification settings - Fork 0
/
hm-fleet-clearance-v1.yml
845 lines (811 loc) · 23.3 KB
/
hm-fleet-clearance-v1.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
openapi: 3.0.3
info:
title: Fleet Clearance API
description: |-
By using the Fleet Clearance API endpoints, it's possible for fleet operators to activate and deactivate data access to their vehicles.
In order to use the API endpoints you will need to retrieve an access token using the [OAuth API](/api-references/code-references/oauth2/reference/v1/) with `client_credentials` grant
* Sandbox server: `https://sandbox.api.high-mobility.com`
* Production server: `https://api.high-mobility.com`
contact:
email: support@high-mobility.com
version: 1.0.0
externalDocs:
description: High Mobility's Developer Console
url: https://www.high-mobility.com
servers:
- url: https://sandbox.api.high-mobility.com
- url: https://api.high-mobility.com
paths:
/v1/fleets/vehicles:
post:
summary: Create a clearance
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVehicleRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVehiclePostResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearanceUnauthorizedErrors'
description: When an invalid ServiceAccountToken is used.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetForbiddenErrors'
description: When the application doesn't have fleet access.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrors'
description: >-
Invalid Input. It occurs when the payload is missing a params or the
the application is not configured.
'500':
description: Server Errors
get:
summary: Get all clearances
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
parameters:
- in: query
name: filter
schema:
type: object
required: false
description: URL Encoded JSON
examples:
vin_eq:
summary: Filter by VIN - Equality
value:
vin:
operator: eq
value: EXVETESTVIN000001
vin_in:
summary: Filter by VIN - Inclusion
value:
vin:
operator: in
value:
- EXVETESTVIN000001
- EXVETESTVIN000002
status_eq:
summary: Filter by Status - Equality
value:
status:
operator: eq
value: approved
status_in:
summary: Filter by Status - Inclusion
value:
status:
operator: in
value:
- approved
- rejected
tags_eq:
summary: Filter by Tags - Equality
value:
tags:
operator: eq
value:
some_key: some_value
tags_contains:
summary: Filter by Tags - Contains
value:
tags:
operator: contains
value:
some_key: some_value
brand_eq:
summary: Filter by Brand - Equality
value:
brand:
operator: eq
value: bmw
brand_in:
summary: Filter by Brand - Inclusion
value:
brand:
operator: in
value:
- bmw
- mercedes-benz
approved_at_eq:
summary: Filter by Approval Date - Equality
value:
approved_at:
operator: eq
value: "1999-03-31T00:00:00Z"
approved_at_lt:
summary: Filter by Approval Date - Less than
value:
approved_at:
operator: lt
value: "1999-03-31T00:00:00Z"
approved_at_gt:
summary: Filter by Approval Date - Greater than
value:
approved_at:
operator: gt
value: "1999-03-31T00:00:00Z"
approved_at_lte:
summary: Filter by Approval Date - Less than or Equal
value:
approved_at:
operator: lte
value: "1999-03-31T00:00:00Z"
approved_at_gte:
summary: Filter by Approval Date - Greater than or Equal
value:
approved_at:
operator: gte
value: "1999-03-31T00:00:00Z"
inserted_at_eq:
summary: Filter by Insertion Date - Equality
value:
inserted_at:
operator: eq
value: "1999-03-31T00:00:00Z"
inserted_at_lt:
summary: Filter by Insertion Date - Less than
value:
inserted_at:
operator: lt
value: "1999-03-31T00:00:00Z"
inserted_at_gt:
summary: Filter by Insertion Date - Greater than
value:
inserted_at:
operator: gt
value: "1999-03-31T00:00:00Z"
inserted_at_lte:
summary: Filter by Insertion Date - Less than or Equal
value:
inserted_at:
operator: lte
value: "1999-03-31T00:00:00Z"
inserted_at_gte:
summary: Filter by Insertion Date - Greater than or Equal
value:
inserted_at:
operator: gte
value: "1999-03-31T00:00:00Z"
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVehicleGetResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearanceUnauthorizedErrors'
description: When an invalid ServiceAccountToken is used.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetForbiddenErrors'
description: When the application doesn't have fleet access.
'500':
description: Server Errors
description: >-
Get the status of VINs that have previously been registered for data
access clearance.
/v1/fleets/vehicles/{vin}:
get:
summary: Get clearance for a vin
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
parameters:
- name: vin
in: path
required: true
schema:
type: string
description: VIN of the vehicle in question.
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVehicleGetItemResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearanceUnauthorizedErrors'
description: When an invalid ServiceAccountToken is used.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetForbiddenErrors'
description: When the application doesn't have fleet access.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrors'
description: Given resource not found
'500':
description: Server Errors
description: >-
Get the status of a VIN that has previously been registered for data
access clearance.
delete:
summary: Delete clearance
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
parameters:
- name: vin
in: path
required: true
schema:
type: string
description: VIN of the vehicle in question.
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVehicleDeleteItemResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearanceUnauthorizedErrors'
description: When an invalid ServiceAccountToken is used.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetForbiddenErrors'
description: When the application doesn't have fleet access.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrors'
description: Given resource not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetDeletionErrors'
description: >-
When deleting a clearance with given VIN is not possible.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetCancellationErrors'
description: >-
When cancellation is not possible at this moment.
'500':
description: Server Errors
description: >-
Delete the clearance for the given VIN. If the vehicle is in approved state, a revoke is attempted. If the clearance is in pending state, the activation process is canceled. **The cancelation is only supported for Mercedes-Bez and Stellantis(Peugeot, DS,Jeep and etc) brands**
/v1/fleets/{vin}/cancel_activation:
post:
summary: Cancel clearance
deprecated: true
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
parameters:
- name: Authorization
in: header
description: 'Bearer token'
required: true
schema:
type: string
- name: vin
in: path
required: true
schema:
type: string
description: VIN of the vehicle in question.
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetVin'
description: ''
'500':
description: Server Errors
description: >-
Deprecated: use DELETE /v1/fleet/vehicles/{vin} end point instead
/v1/fleets/access_tokens:
post:
summary: Get access token
deprecated: true
security:
- FleetClearanceAuth:
- fleet:clearance
tags:
- Fleet Clearance Resource
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessTokensResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessTokensError'
description: Error
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearanceUnauthorizedErrors'
description: When an invalid ServiceAccountToken is used.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrors'
description: When the application doesn't have fleet access.
'500':
description: Server Errors
description: >-
Creates an access token for a VIN that has the "approved" state. This
access token can be used to retrieve car data through any of the SDKs or
the REST API.
components:
schemas:
FleetVehicleGetResponse:
type: array
title: FleetVehicleGetResponse
items:
$ref: '#/components/schemas/FleetVehicleGetItemResponse'
example:
- vin: VIN0TESTVIN000000
status: approved
brand: mercedes-benz
tags:
foo: bar
bar: baz
changelog:
- timestamp: "2022-03-22T09:36:51"
status: pending
- timestamp: "2022-03-22T10:36:51"
status: approved
FleetForbiddenErrors:
type: object
title: Errors
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/components/schemas/Error'
example:
- detail: This service account is not associated with a fleet.
source: Authorization
title: Forbidden
ClearanceUnauthorizedErrors:
type: object
title: Errors
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/components/schemas/Errors'
example:
- detail: >
Missing or invalid authorization header. The token must be
obtained through the service account API and sent as a header with
the format "Authorization: Bearer <token>"
source: Authorization
Errors:
type: array
title: Errors
items:
$ref: '#/components/schemas/Error'
description: List of errors
Error:
type: object
title: Error
required:
- title
properties:
title:
type: string
description: Error title
source:
type: string
description: Field that has problem
detail:
type: string
description: Error detail
description: Error details
FleetVehicleRequest:
type: object
properties:
vehicles:
type: array
items:
$ref: '#/components/schemas/FleetVehicle'
description: Vehicle list
example:
vehicles:
- vin: WBADT43452G296403
brand: mercedes-benz
tags: {}
- vin: WBADT43452G296404
brand: bmw
tags: {}
- vin: VIN012345678901234
brand: ds
tags: {}
- vin: VIN01234567890123
brand: unknown
tags:
foo: bar
bar: baz
required:
- vehicles
FleetVehicle:
type: object
title: FleetVehicle
required:
- vin
- brand
properties:
vin:
type: string
description: Vehicle Identification Number (VIN)
brand:
type: string
enum:
- bmw
- citroen
- ds
- mercedes-benz
- mini
- opel
- peugeot
- vauxhall
- jeep
- fiat
- alfaromeo
- ford
- renault
- toyota
- lexus
- porsche
- maserati
- kia
- tesla
- volvo-cars
- sandbox
description: Vehicle Brand
control_measures:
deprecated: true
type: object
properties:
odometer:
required:
- value
- unit
type: object
properties:
value:
type: integer
unit:
type: string
enum:
- kilometers
- miles
tags:
type: object
additionalProperties:
type: string
FleetVehiclePostResponse:
type: object
title: FleetVehiclePostResponse
required:
- vehicles
properties:
vehicles:
type: array
items:
$ref: '#/components/schemas/FleetVin'
description: Vehicle list
example:
vehicles:
- vin: WBADT43452G296403
status: pending
tags: {}
- vin: WBADT43452G296404
status: pending
tags:
foo: bar
bar: baz
- vin: VIN012345678901234
status: error
description: vin should be 17 character(s)
- vin: VIN0123456789012
status: error
description: The brand is invalid
FleetVin:
type: object
title: FleetVin
required:
- vin
- status
properties:
vin:
type: string
description: Vehicle Identification Number (VIN)
status:
type: string
enum:
- approved
- pending
- revoked
- rejected
- revoking
- canceling
- canceled
- error
description: >-
An access token can be retrieved for the FleetVin if the status is
"approved"
description:
type: string
description: Optional description of the VIN
tags:
type: object
additionalProperties:
type: string
example:
vin: WBADT43452G296403
status: pending
tags:
foo: bar
bar: baz
FleetErrors:
type: object
title: Errors
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/components/schemas/Error'
FleetVehicleGetItemResponse:
type: object
title: FleetVehicle
required:
- vin
- status
properties:
vin:
type: string
description: Vehicle Identification Number (VIN)
status:
type: string
enum:
- approved
- pending
- revoking
- revoked
- rejected
- canceling
- canceled
brand:
type: string
enum:
- bmw
- citroen
- ds
- mercedes-benz
- mini
- opel
- peugeot
- vauxhall
- jeep
- fiat
- alfaromeo
- ford
- renault
- toyota
- lexus
- porsche
- maserati
- kia
- tesla
- volvo-cars
- sandbox
changelog:
type: array
items:
$ref: '#/components/schemas/FleetVinChangelog'
tags:
type: object
additionalProperties:
type: string
FleetVinChangelog:
type: object
required:
- timestamp
- status
properties:
timestamp:
type: string
description: 'Date and Time in ISO8601 format example: ''2018-11-06T10:20:37.094533Z'''
status:
type: string
enum:
- approved
- pending
- revoking
- revoked
- rejected
- canceling
- canceled
FleetDeletionErrors:
type: object
title: Errors
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/components/schemas/Error'
example:
- detail: Clearance is already removed
source: vin
title: Conflict
- detail: Clearance is in transition mode
source: vin
title: Conflict
FleetCancellationErrors:
type: object
title: Errors
properties:
errors:
description: List of errors
type: array
items:
$ref: '#/components/schemas/Error'
example:
- detail: cancellation is not supported for this vin
source: vin
title: not supported
- detail: the pending status could only be canceled after 1 day it's created
source: status
title: too early
FleetVehicleDeleteItemResponse:
type: object
title: FleetVehicle
required:
- vin
- status
properties:
vin:
type: string
description: Vehicle Identification Number (VIN)
status:
type: string
enum:
- revoking
- canceling
tags:
type: object
additionalProperties:
type: string
example:
vin: VIN0TESTVIN000000
status: revoking
tags:
foo: bar
bar: baz
AccessTokensResponse:
type: object
title: AccessTokensResponse
required:
- expires_in
- access_token
- token_type
properties:
validity_start_date:
type: string
description: 'Date and Time in ISO8601 format example: ''2018-11-06T10:20:37.094533Z'''
validity_end_date:
type: string
description: 'Date and Time in ISO8601 format example: ''2018-11-06T10:20:37.094533Z'''
token_type:
type: string
description: Token type
scope:
type: string
description: List of scopes
refresh_token:
type: string
description: Refresh token
expires_in:
type: integer
description: Expiration time in seconds
access_token:
type: string
description: Access token
example:
token_type: bearer
scope: >-
diagnostics.get.mileage door_locks.get.locks
windows.get.windows_positions
refresh_token: 7f7a9be0-04c9-4202-a59f-35d55079b6ba
expires_in: 600
access_token: a50e89e5-093c-4727-8101-4c6e81addabe
description: Access Tokens
FleetAccessTokensRequest:
type: object
properties:
vin:
type: string
description: The VIN of the vehicle to ask access to.
example:
vin: WBADT43452G296403
required:
- vin
AccessTokensError:
type: object
title: AccessTokensError
required:
- error
properties:
error_description:
type: string
description: Error description
error:
type: string
description: Error code
description: Error details
securitySchemes:
FleetClearanceAuth:
flows:
clientCredentials:
scopes:
fleet:clearance: fleet clearance
tokenUrl: https://api.sandbox.high-mobility.com/v1/access_token
type: oauth2