Compare commits

...

24 Commits

Author SHA1 Message Date
eb8630ff24 New Endpoint /Filters2, to make implementation easier 2026-04-09 14:34:58 +02:00
2960d1bd36 Each branch has now hints 2026-02-24 09:41:23 +01:00
6eda09efbe More fields and some bugfixes 2026-01-30 07:45:25 +01:00
dc1751b852 Update README.md 2026-01-30 07:44:50 +01:00
760da37fe3 Methods to search the exact predecessor and successor 2026-01-30 07:44:48 +01:00
adb589ef49 New fields for redirecting to a customer url 2025-10-29 08:42:56 +01:00
fbcb1ff6bb Filters extended for PairSearch 2025-10-20 09:08:40 +02:00
68eca53428 Added Motorcycle-Data 2025-10-17 09:41:45 +02:00
694582091b Typing error 2025-10-16 15:16:36 +02:00
254d3b09ae Search by motorcycles 2025-10-16 14:57:10 +02:00
1c7255fa72 Abfrage von Zuhebörteilen, wie z.B. Schläuchen 2025-10-16 11:33:09 +02:00
574b8caf49 Reorganization for better understanding 2025-10-16 10:14:28 +02:00
dacc6cade4 Pair- or Couplesearch implementation
For different dimensions of front and rear axle
2025-10-16 09:25:45 +02:00
6d93e58c98 New Endpoint for StockDetails of an article
And some more descriptions for stock coloumns. The clients are using often abbreviations
2025-10-15 11:17:18 +02:00
1edeb5178d Raw ProgramIdentifier 2025-10-07 09:28:58 +02:00
1e6a843330 Added designations for any UI, to show 2025-09-12 10:27:34 +02:00
b797105afc Added GuidOnlineService-Parameter 2025-09-04 06:38:13 +02:00
741f6c34dd Providing information about top sold articles 2025-08-21 10:28:38 +02:00
cb2e4d1d60 Added Areas
These are blocks on the page to show custom content. Like typical advertisment-blocks on other websites.
2025-08-21 09:40:40 +02:00
7449bb1a06 Wrong type 2025-08-21 07:44:08 +02:00
791d46ff6b ShopArticleInformation added. I.e. photos and marketing stuff 2025-08-21 07:40:44 +02:00
5b9a836c65 V10 - rework of Blob-Handling 2025-08-20 10:33:58 +02:00
cec3fa68ad The updated document gets returned 2025-08-20 10:30:59 +02:00
00243eb3b5 Small enhancements due to requests 2025-08-05 14:23:49 +02:00
4 changed files with 1029 additions and 259 deletions

View File

@@ -19,6 +19,7 @@ https://www.astera.com/de/type/blog/api-design-best-practices
https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/ https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/
https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/ https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/
https://www.akamai.com/blog/security/rest-api-security-best-practices https://www.akamai.com/blog/security/rest-api-security-best-practices
https://jakarta.ee/specifications/data/1.0/
# Examples # Examples
@@ -26,3 +27,4 @@ https://docs.hetzner.cloud/
https://opensource.zalando.com/restful-api-guidelines https://opensource.zalando.com/restful-api-guidelines
https://kubernetes.io/docs/reference/using-api/api-concepts https://kubernetes.io/docs/reference/using-api/api-concepts
https://docs.stripe.com/api/prices https://docs.stripe.com/api/prices
https://developer.clickup.com/docs/authentication

View File

@@ -1287,6 +1287,62 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/Documents/{Guid}/custommethods/AcceptOffer:
post:
tags:
- "Documents"
description: "Accepts an offer. Dependant on the implementation, it could be that the offer is after the operation an order."
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
- name: "Comment"
in: "query"
required: false
schema:
type: "string"
default: null
example: "Thanks you!"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
401:
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/Documents/{Guid}/custommethods/RejectOffer:
post:
tags:
- "Documents"
description: "Rejects an offer. Dependant on the implementation, the offer keeps beeing open for further responses or gets historic."
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
- name: "Comment"
in: "query"
required: false
schema:
type: "string"
default: null
example: "The price is higher than excepted. Can you make another offer?"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
401:
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/DocumentPositions: /DocumentPositions:
get: get:
tags: tags:
@@ -4137,6 +4193,7 @@ components:
- "GuidOnlineSchedulerService" - "GuidOnlineSchedulerService"
- "GuidBranch" - "GuidBranch"
- "IsDefault" - "IsDefault"
- "Hints"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -4146,6 +4203,22 @@ components:
type: "string" type: "string"
IsDefault: IsDefault:
type: "string" type: "string"
Hints:
type: "array"
items:
type: "object"
required:
- "AttentionLevel"
- "Hint"
properties:
AttentionLevel:
type: "string"
enum:
- "Low"
- "Mid"
- "High"
Hint:
type: "string"
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
example: example:
@@ -4206,6 +4279,7 @@ components:
- "UsersMayEnterANewLicenceTag" - "UsersMayEnterANewLicenceTag"
- "IsConnectedWithATyreStorage" - "IsConnectedWithATyreStorage"
- "DeadlineTimeInSecondsSinceMidnight" - "DeadlineTimeInSecondsSinceMidnight"
- "DeadlineTimeInSecondsSinceMidnight"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -4230,6 +4304,16 @@ components:
type: "boolean" type: "boolean"
DeadlineTimeInSecondsSinceMidnight: DeadlineTimeInSecondsSinceMidnight:
type: "integer" type: "integer"
RedirectUrlType:
type: "string"
enum:
- "None"
- "NewTab"
- "SameTab"
RedirectUrl:
type: "string"
RedirectUrlShallBeShownAsOptionalButton:
type: "boolean"
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
example: example:

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, TPMS" title: "TyrePro-API, TPMS"
version: "Version 6" version: "Version 7"
servers: servers:
- url: "https://musterreifen.com/api/tpms" - url: "https://musterreifen.com/api/tpms"
description: "Development server" description: "Development server"
@@ -167,6 +167,23 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Predecessor:
get:
tags:
- "TPMS / customer storage"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerStorage"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Rearrange: /CustomerStorages/{Guid}/custommethods/Rearrange:
post: post:
tags: tags:
@@ -184,6 +201,23 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Successor:
get:
tags:
- "TPMS / customer storage"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerStorage"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStoragePositions/{Guid}: /CustomerStoragePositions/{Guid}:
get: get:
tags: tags:
@@ -1353,6 +1387,12 @@ components:
type: "integer" type: "integer"
CustomerName1: CustomerName1:
type: "string" type: "string"
StorageDesignation:
type: "string"
StoragePlaceDesignation:
type: "string"
RemoteStorageReference:
type: "string"
Documents: Documents:
type: "array" type: "array"
items: items:
@@ -1458,6 +1498,8 @@ components:
type: "string" type: "string"
GuidStorageLocation: GuidStorageLocation:
type: "string" type: "string"
RemoteStorageReference:
type: "string"
CommentExternal: CommentExternal:
type: "string" type: "string"
CommentInternal: CommentInternal:
@@ -1470,6 +1512,7 @@ components:
- "Guid" - "Guid"
- "GuidCustomerStorage" - "GuidCustomerStorage"
- "PositionDescription" - "PositionDescription"
- "PositionDescriptionDesignation"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@@ -1479,6 +1522,8 @@ components:
readOnly: true readOnly: true
PositionDescription: PositionDescription:
type: "string" type: "string"
PositionDescriptionDesignation:
type: "string"
GuidArticleTyre: GuidArticleTyre:
type: "string" type: "string"
TyreDimension: TyreDimension:
@@ -1547,10 +1592,13 @@ components:
type: "object" type: "object"
readOnly: true readOnly: true
required: required:
- "Guid"
- "Type" - "Type"
- "Designation" - "Designation"
- "Axles" - "Axles"
properties: properties:
Guid:
type: "string"
Type: Type:
type: "string" type: "string"
enum: enum:
@@ -1574,6 +1622,7 @@ components:
- "IsDrivingAxle" - "IsDrivingAxle"
- "IsReserveAxle" - "IsReserveAxle"
- "IsSteeringAxle" - "IsSteeringAxle"
- "Designation"
- "Positions" - "Positions"
properties: properties:
BlockNumberFrontToBack: BlockNumberFrontToBack:
@@ -1584,6 +1633,8 @@ components:
type: "boolean" type: "boolean"
IsSteeringAxle: IsSteeringAxle:
type: "boolean" type: "boolean"
Designation:
type: "string"
Positions: Positions:
type: "array" type: "array"
items: items:
@@ -1591,11 +1642,14 @@ components:
required: required:
- "BlockNumberLeftToRight" - "BlockNumberLeftToRight"
- "PositionDescription" - "PositionDescription"
- "Designation"
properties: properties:
BlockNumberLeftToRight: BlockNumberLeftToRight:
type: "integer" type: "integer"
PositionDescription: PositionDescription:
type: "string" type: "string"
Designation:
type: "string"
ChassisNumber: ChassisNumber:
type: "string" type: "string"
EgTypeApprovalNumber: EgTypeApprovalNumber:
@@ -1640,6 +1694,7 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "ProgramIdentifier"
- "ProgramIdentifierDesignation" - "ProgramIdentifierDesignation"
- "Type" - "Type"
- "Designation" - "Designation"
@@ -1651,6 +1706,9 @@ components:
ProgramIdentifierDesignation: ProgramIdentifierDesignation:
type: "string" type: "string"
readOnly: true readOnly: true
ProgramIdentifier:
type: "string"
readOnly: true
Type: Type:
type: "string" type: "string"
enum: enum: