From e4ab84592fcaa89fa303e4933d0a63fb2a7f9d71 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Thu, 24 Jul 2025 10:47:29 +0200 Subject: [PATCH 1/4] updated base url SE customers endpoints --- src/openapi/customers/SE-customers.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index fe349a6..709d7dc 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -6,7 +6,8 @@ info: To be used by touchpoints to get information about HTM customers. version: "1.0" servers: - - url: https://api.integratielaag.nl/v1/touchpoint + - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 + - url: https://services.api.htm.nl/abt/touchpoint/1.0 tags: - name: Customers description: >- From a7afa7ff58f562b7150c4aea4517abdfa118ccb0 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Thu, 24 Jul 2025 16:36:46 +0200 Subject: [PATCH 2/4] added all the urls on ACC --- src/openapi/contracts/contracts-crud.yaml | 2 +- src/openapi/contracts/contracts-se.yaml | 3 +- src/openapi/customers/SE-customers.yaml | 2 +- src/openapi/customers/customers-crud-v2.yaml | 3 +- .../customers/customers_reference-crud.yaml | 4 +- src/openapi/fiko/fiko-crud.yaml | 2 +- src/openapi/fiko/fikoreference-crud.yaml | 381 ------------------ .../orders/SE-orders-gboAgeProfile.yaml | 5 +- src/openapi/orders/orders-crud.yaml | 2 +- src/openapi/orders/service_engine_orders.yaml | 5 +- src/openapi/products/SE-products-SE.yaml | 5 +- src/openapi/products/SE-products-TP.yaml | 5 +- .../products/productreference-crud.yaml | 2 +- src/openapi/products/products-crud.yaml | 2 +- .../products/purchased_products-crud.yaml | 2 +- src/openapi/util/util-crud.yaml | 2 +- 16 files changed, 26 insertions(+), 401 deletions(-) delete mode 100644 src/openapi/fiko/fikoreference-crud.yaml diff --git a/src/openapi/contracts/contracts-crud.yaml b/src/openapi/contracts/contracts-crud.yaml index f39f4cb..3b123f2 100644 --- a/src/openapi/contracts/contracts-crud.yaml +++ b/src/openapi/contracts/contracts-crud.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: CRUD APIs for ABT Contract database. These are NOT the functional APIs from Service Engine. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://services.acc.api.htm.nl/abt/abtcontracts/1.0 paths: /customers/{customerNumber}/contracts: parameters: diff --git a/src/openapi/contracts/contracts-se.yaml b/src/openapi/contracts/contracts-se.yaml index f1b49a7..3f898db 100644 --- a/src/openapi/contracts/contracts-se.yaml +++ b/src/openapi/contracts/contracts-se.yaml @@ -4,7 +4,8 @@ info: version: "1.0" description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub. servers: - - url: https://api.integratielaag.nl/abt/touchpoint/1.0 + - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 + - url: https://services.api.htm.nl/abt/touchpoint/1.0 paths: /customers/contracts: parameters: diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index 709d7dc..003d0b8 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -7,7 +7,7 @@ info: version: "1.0" servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 - - url: https://services.api.htm.nl/abt/touchpoint/1.0 + - url: http://services.acc.api.htm.nl/abt/touchpoint/1.0 tags: - name: Customers description: >- diff --git a/src/openapi/customers/customers-crud-v2.yaml b/src/openapi/customers/customers-crud-v2.yaml index feb9f40..d17bb5c 100644 --- a/src/openapi/customers/customers-crud-v2.yaml +++ b/src/openapi/customers/customers-crud-v2.yaml @@ -4,7 +4,8 @@ info: version: "2.0" description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine. servers: - - url: https://api.integratielaag.nl/abt/abtcustomers/2.0 + - url: https://services.acc.api.htm.nl/abt/abtcustomers/2.0 + - url: http://services.acc.api.htm.nl/abt/abtcustomers/2.0 paths: /customers: get: diff --git a/src/openapi/customers/customers_reference-crud.yaml b/src/openapi/customers/customers_reference-crud.yaml index 748d98d..d63b899 100644 --- a/src/openapi/customers/customers_reference-crud.yaml +++ b/src/openapi/customers/customers_reference-crud.yaml @@ -3,8 +3,8 @@ info: title: ABTCustomerReference version: '1.0' servers: - - url: https://services.dev.api.htm.nl/abt/customerreference/1.0 - - url: http://services.dev.api.htm.nl/abt/customerreference/1.0 + - url: https://services.acc.api.htm.nl/abt/customerreference/1.0 + - url: http://services.acc.api.htm.nl/abt/customerreference/1.0 security: - default: [] tags: diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index f7b30f8..8b3908f 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -6,7 +6,7 @@ info: CRUD APIs for FIKO resource model v2.2. This version of the API corresponds with version 2.2 of the data model in [Lucid Chart](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?page=LL7PJg1Y_GOA>). servers: - - url: https://api.integratielaag.nl/fiko/1.0 + - url: https://services.acc.api.htm.nl/fiko/1.0 paths: /Odata/TransactionItem: get: diff --git a/src/openapi/fiko/fikoreference-crud.yaml b/src/openapi/fiko/fikoreference-crud.yaml deleted file mode 100644 index 52969ac..0000000 --- a/src/openapi/fiko/fikoreference-crud.yaml +++ /dev/null @@ -1,381 +0,0 @@ -openapi: 3.0.1 -info: - title: ABTFikoReference - description: |- - CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)). This means that, for now, only GET endpoints on `TaxMetadata` and `ProductGroupMetadata` (already named `ProductMetadata` to avoid rework for v2) are available. - - When the v2 model for FIKO is implemented (see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)), POST/PUT/DELETE for these tables (as well as CRUD for additional tables) will become available, to support populating the reference tables with Unit4Financials data. - - These are NOT functional API's to be published by the Service Engine, but are direct CRUD API's on top of the database. - version: '1.0' -servers: - - url: https://api.integratielaag.nl/abt/fikoreference/1.0 -tags: - - name: ABTFikoReference CRUD v1 - description: >- - CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)). - - name: ABTFikoReference CRUD v2 - description: >- - CRUD APIs for FIKO reference data (based on the v2 model for FIKO, see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)). - -paths: - /taxmetadata: - get: - tags: - - ABTFikoReference CRUD v1 - summary: Get a list of all possible values of the "TaxMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example). - description: |- - Get a list of all possible values of the `TaxMetadata` reference table. Mainly used for populating dropdown lists (in PMT for example).\ - The attributes `validFrom` and `validUntil` are not yet present in the FIKO v1 datamodel, but are already included in this resourcemodel; to prevent rework in the near future.\ - For now, for `validFrom`, the value will always be returned as `2024-01-01T00:00:00.000+00:00` and for `validUntil` it will always be `null`. - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/TaxMetadataListResponse' - examples: - getListTaxMetadataSales: - summary: List containing three TaxMetadata entries, used for sales tax - value: - { - "Entries": [ - { - "taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745", - "taxCode": "V21", - "taxPercentageAmount": 21, - "description": "BTW VERKOOP HOOG 21%", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - }, - { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - }, - { - "taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - } - ] - } - getListTaxMetadataSalesAndPurchase: - summary: List containing x TaxMetadata entries, used for sales and purchase tax - value: - { - "Entries": [ - { - "taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745", - "taxCode": "V21", - "taxPercentageAmount": 21, - "description": "BTW VERKOOP HOOG 21%", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - }, - { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - }, - { - "taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL", - "validFrom": "2024-01-01T00:00:00.000+00:00", - "validUntil": null - }, - { - "TBD": "TBD" - }, - { - "TBD": "TBD" - }, - { - "TBD": "TBD" - } - ] - } - '400': - description: '400' - content: - application/json: - schema: - $ref: '#/components/schemas/400Response' - '401': - description: '401' - content: - application/json: - schema: - $ref: '#/components/schemas/401Response' - '404': - description: '404' - content: - application/json: - schema: - $ref: '#/components/schemas/404Response' - '500': - description: '500' - content: - application/json: - schema: - $ref: '#/components/schemas/500Response' - /productmetadata: - get: - tags: - - ABTFikoReference CRUD v1 - summary: Get a list of all possible values of the "ProductMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example). - description: |- - Get a list of all possible values of the `ProductGroupMetadata` (soon to be renamed to `ProductMetadata`) reference table. Mainly used for populating dropdown lists (in PMT for example).\ - The name of the entity is `ProductGroupMetadata` in the FIKO v1 datamodel, but the resourcemodel already uses the name `ProductMetadata`, as will be the name from FIKO v2 onwards.\ - This also applies to the attributes `productMetadataId` (still called `ProductGroupMetadataId` in FIKO v1), `productCode` (still called `productGroupCode` in FIKO v1) and `user` (present in FIKO v1, but removed in FIKO v2, so also in this resourcemodel). - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ProductMetadataListResponse' - examples: - getListProductMetadata: - summary: List containing one ProductMetadata entry, used for testing purposes - value: - { - "Entries": [ - { - "productMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "productCode": "PG001", - "department": "Electronics", - "costCenter": "CC101", - "costType": "TypeA", - "description": "Group for electronic products", - "documentCode": "DOC001", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - } - ], - } - '400': - description: '400' - content: - application/json: - schema: - $ref: '#/components/schemas/400Response' - '401': - description: '401' - content: - application/json: - schema: - $ref: '#/components/schemas/401Response' - '404': - description: '404' - content: - application/json: - schema: - $ref: '#/components/schemas/404Response' - '500': - description: '500' - content: - application/json: - schema: - $ref: '#/components/schemas/500Response' - -components: - schemas: - TaxMetadataListResponse: - type: object - required: - - Entries - properties: - Entries: - type: array - items: - $ref: '#/components/schemas/TaxMetadataResponse' - ProductMetadataListResponse: - type: object - required: - - Entries - properties: - Entries: - type: array - items: - $ref: '#/components/schemas/ProductMetadataResponse' - TaxMetadataResponse: - type: object - required: - - taxMetadataId - - taxCode - - taxPercentageAmount - - validFrom - properties: - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - taxCode: - type: string - example: V09 - taxPercentageAmount: - type: integer - example: 21 - description: - type: string - example: BTW VERKOOP LAAG 9% - validFrom: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validUntil: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - ProductMetadataResponse: - type: object - required: - - productMetadataId - - productCode - - department - - costCenter - - costType - - description - - documentCode - - timestampUpdated - - validFrom - properties: - productMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - productCode: - type: string - description: Called "artikelnr" in U4F - example: TBD - department: - type: string - description: Called "element 1" in U4F - example: TBD - costCenter: - type: string - description: Called "element 3" in U4F - example: TBD - costType: - type: string - description: Called "element 2" in U4F - example: TBD - description: - type: string - example: TBD - documentCode: - type: string - example: TBD - timestampUpdated: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validFrom: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validUntil: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - 400Response: - type: object - properties: - code: - type: string - example: '400' - type: - type: string - message: - type: string - example: Bad Request - description: - type: string - example: '''2023-02-01 00:00:00'' is not a valid Datetime' - apiErrorCode: - type: string - example: htm.api.err.40xxx - 401Response: - type: object - properties: - code: - type: string - example: '900901' - type: - type: string - message: - type: string - example: Invalid Credentials - description: - type: string - example: >- - Invalid Credentials. Make sure you have provided the correct - security credentials - apiErrorCode: - type: string - example: htm.api.err.40xxx - 403Response: - type: object - properties: - code: - type: string - example: '900901' - type: - type: string - message: - type: string - example: Retailer not authorized - description: - type: string - example: The retailer is not allowed to access resource for requested - apiErrorCode: - type: string - example: htm.api.err.40xxx touchpoint - 404Response: - type: object - properties: - code: - type: string - example: '404' - type: - type: string - example: Status report - message: - type: string - example: Not Found - description: - type: string - example: The requested resource is not available. - apiErrorCode: - type: string - example: htm.api.err.40xxx - 500Response: - type: object - properties: - code: - type: string - example: '500' - type: - type: string - message: - type: string - example: Internal Server Error - description: - type: string - apiErrorCode: - type: string - example: htm.api.err.40xxx diff --git a/src/openapi/orders/SE-orders-gboAgeProfile.yaml b/src/openapi/orders/SE-orders-gboAgeProfile.yaml index a78d4e4..95cfd7d 100644 --- a/src/openapi/orders/SE-orders-gboAgeProfile.yaml +++ b/src/openapi/orders/SE-orders-gboAgeProfile.yaml @@ -3,8 +3,9 @@ info: title: ABT Service Engine Order APIs version: "1.0" description: Order APIs available in the Service Engine for order validation and fulfillment. -servers: - - url: https://api.integratielaag.nl/abt/abtserviceengine/1.0 +servers: + - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0 + - url: https://services.api.htm.nl/abt/touchpoint/2.0 paths: /orders/validation/gboAgeProfile: get: diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 182502d..29e2583 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://services.acc.api.htm.nl/abt/abtorder/1.0 paths: /orders: get: diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 78c4bb9..16c5ee0 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -3,8 +3,9 @@ info: title: ABT Service Engine Order APIs version: "1.0" description: Order APIs available in the Service Engine for order validation and fulfillment. -servers: - - url: https://api.integratielaag.nl/v2 +servers: + - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0 + - url: https://services.api.htm.nl/abt/touchpoint/2.0 paths: /orders/validation: post: diff --git a/src/openapi/products/SE-products-SE.yaml b/src/openapi/products/SE-products-SE.yaml index 06ba8cc..bc29f13 100644 --- a/src/openapi/products/SE-products-SE.yaml +++ b/src/openapi/products/SE-products-SE.yaml @@ -5,8 +5,9 @@ info: Service Engine APIs for HTM products. These are NOT the CRUD APIs to access raw data in the database. To be used by touchpoints to get information about HTM products they are allowed to see and/or sell. version: "1.0" -servers: - - url: https://api.integratielaag.nl/abt/abtserviceengine/1.0 +servers: + - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 + - url: https://services.api.htm.nl/abt/touchpoint/1.0 tags: - name: ServiceEngine Products description: |- diff --git a/src/openapi/products/SE-products-TP.yaml b/src/openapi/products/SE-products-TP.yaml index a9fa5de..6e89ae2 100644 --- a/src/openapi/products/SE-products-TP.yaml +++ b/src/openapi/products/SE-products-TP.yaml @@ -5,8 +5,9 @@ info: Service Engine APIs for HTM products. These are NOT the CRUD APIs to access raw data in the database. To be used by touchpoints to get information about HTM products they are allowed to see and/or sell. version: "1.0" -servers: - - url: https://api.integratielaag.nl/abt/touchpoint/1.0 +servers: + - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 + - url: https://services.api.htm.nl/abt/touchpoint/1.0 tags: - name: ServiceEngine Products description: |- diff --git a/src/openapi/products/productreference-crud.yaml b/src/openapi/products/productreference-crud.yaml index dc0f9d7..61b5e2b 100644 --- a/src/openapi/products/productreference-crud.yaml +++ b/src/openapi/products/productreference-crud.yaml @@ -7,7 +7,7 @@ info: Service Engine, using a different endpoint. version: '1.0' servers: - - url: https://api.integratielaag.nl/abt/productreference/1.0 + - url: https://services.acc.api.htm.nl/abt/productreference/1.0 tags: - name: ABTProductReference CRUD description: >- diff --git a/src/openapi/products/products-crud.yaml b/src/openapi/products/products-crud.yaml index 3afaaa7..f0a72ce 100644 --- a/src/openapi/products/products-crud.yaml +++ b/src/openapi/products/products-crud.yaml @@ -7,7 +7,7 @@ info: Service Engine, using a different endpoint. version: '1.0' servers: - - url: https://api.integratielaag.nl/abt/products/1.0 + - url: https://services.acc.api.htm.nl/abt/abtproducts/1.0 tags: - name: ABTProducts CRUD description: >- diff --git a/src/openapi/products/purchased_products-crud.yaml b/src/openapi/products/purchased_products-crud.yaml index 2305f96..7bacd3b 100644 --- a/src/openapi/products/purchased_products-crud.yaml +++ b/src/openapi/products/purchased_products-crud.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: CRUD APIs for ABT Purchased Products database. These are NOT the functional APIs from Service Engine. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://services.acc.api.htm.nl/abt/abtproducts/1.0 paths: /purchasedproducts: get: diff --git a/src/openapi/util/util-crud.yaml b/src/openapi/util/util-crud.yaml index ddf015c..f0c64bb 100644 --- a/src/openapi/util/util-crud.yaml +++ b/src/openapi/util/util-crud.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: CRUD APIs for ABT Utility tables. These are NOT the functional APIs from Service Engine. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://services.acc.api.htm.nl/abt/abtutility/1.0 paths: /scheduledactions: get: From bc50dc58eaef93f34c5b5779a62fc120b3e07f39 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Jul 2025 10:32:15 +0200 Subject: [PATCH 3/4] padp-poc-openapi.yaml --- src/openapi/pad/padp-poc-openapi.yaml | 760 ++++++++++++++++++++++++++ 1 file changed, 760 insertions(+) create mode 100644 src/openapi/pad/padp-poc-openapi.yaml diff --git a/src/openapi/pad/padp-poc-openapi.yaml b/src/openapi/pad/padp-poc-openapi.yaml new file mode 100644 index 0000000..481e878 --- /dev/null +++ b/src/openapi/pad/padp-poc-openapi.yaml @@ -0,0 +1,760 @@ +openapi: 3.0.1 +info: + title: PadpReferenceApi + version: '1.0' +paths: + /poc/encrypt-decrypt-poc: + get: + tags: + - Encrypt/decrypt POC + summary: Encrypt/Decrypt POC + operationId: EncryptDecryptPoc + parameters: + - name: textToEncrypt + in: header + required: true + schema: + type: string + - name: encryptedEphemeralKey + in: query + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + /poc/encrypt-poc: + get: + tags: + - Encrypt/decrypt POC + summary: Encrypt POC + operationId: EncryptPoc + parameters: + - name: textToEncrypt + in: header + required: true + schema: + type: string + - name: encryptedEphemeralKey + in: query + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + /poc/decrypt-poc: + get: + tags: + - Encrypt/decrypt POC + summary: Decrypt POC + operationId: DecryptPoc + parameters: + - name: textToDecrypt + in: header + required: true + schema: + type: string + - name: encryptedEphemeralKey + in: query + required: true + schema: + type: string + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + /idp/b2b-access-token: + get: + tags: + - PADP Reference API + summary: API 1020 - Get B2B Access Token + description: Returns a client access token, needed for most other PADP APIs. + operationId: GetB2bAccessToken + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/B2bAccessToken' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /get-image-from-base64: + get: + tags: + - PADP Reference API + summary: Get rendered image from Base64 encoded String + operationId: GetImageFromBase64 + parameters: + - name: base64String + in: header + required: true + schema: + type: string + responses: + '200': + description: OK + content: + image/jpeg: + schema: + $ref: '#/components/schemas/FileContentHttpResult' + /personal-data/{xtat}: + post: + tags: + - PADP Reference API + summary: API 1201 - Create Personal Data - First create an ephemeral key using API 1210! + description: First create an ephemeral key using API 1210! + operationId: CreatePersonalData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + - name: email + in: query + description: Email address to be used for OTP challenges + required: true + schema: + type: string + - name: name + in: query + description: Should be at least two words (first name and last name) + schema: + type: string + - name: birthDate + in: query + description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + photo: + type: string + description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720 + format: binary + encoding: + photo: + style: form + responses: + '201': + description: Created + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + get: + tags: + - PADP Reference API + summary: API 1202 - Get Personal Data- First perform an OTP challenge using API 1206 and 1207! + description: First perform an OTP challenge using API 1206 and 1207! + operationId: GetPersonalData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalData' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + delete: + tags: + - PADP Reference API + summary: API 1204 - Delete Personal Data - First perform an OTP challenge using API 1206 and 1207! + description: First perform an OTP challenge using API 1206 and 1207! + operationId: DeletePersonalData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DeletePersonalDataResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + put: + tags: + - PADP Reference API + summary: API 1205 - Update Personal Data - First perform an OTP challenge using API 1206 and 1207! + description: First perform an OTP challenge using API 1206 and 1207!Performs a complete replacement; empty request parameters will result in the corresponding PADP attribute being deleted. + operationId: UpdatePersonalData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + - name: skipUpdateCounter + in: query + required: true + schema: + type: boolean + - name: name + in: query + description: Should be at least two words (first name and last name) + schema: + type: string + - name: birthDate + in: query + description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + photo: + type: string + description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720 + format: binary + encoding: + photo: + style: form + responses: + '200': + description: OK + /personal-data/{xtat}/decrypted: + get: + tags: + - PADP Reference API + summary: API 1202 - Get Personal Data AND decrypt response - First perform an OTP challenge using API 1206 and 1207! + description: First perform an OTP challenge using API 1206 and 1207! + operationId: GetDecryptedPersonalData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DecryptedPersonalData' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /personal-data/{xtat}/generate-otp: + get: + tags: + - PADP Reference API + summary: API 1206 - Generate OTP + operationId: GenerateOtp + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OtpResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /personal-data/{xtat}/validate-otp: + get: + tags: + - PADP Reference API + summary: API 1207 - Validate OTP + operationId: ValidateOtp + parameters: + - name: xtat + in: path + required: true + schema: + type: string + - name: otp + in: query + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/UserAccessToken' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /personal-data/{xtat}/encrypted-update-init: + get: + tags: + - PADP Reference API + summary: API 1210 - Create Ephemeral Key + operationId: CreateEphemeralKey + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EphemeralKey' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /personal-data/{xtat}/administrative-data: + get: + tags: + - PADP Reference API + summary: API 1211 - Get Administrative Data + operationId: GetAdministrativeData + parameters: + - name: xtat + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdministrativeData' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' +components: + schemas: + AdministrativeData: + type: object + properties: + name: + $ref: '#/components/schemas/AdministrativeDataElement' + photo: + $ref: '#/components/schemas/AdministrativeDataElement' + birthdate: + $ref: '#/components/schemas/AdministrativeDataElement' + additionalProperties: false + AdministrativeDataElement: + type: object + properties: + inaccuracyFlag: + type: boolean + inaccuracyFlagReason: + type: string + nullable: true + inaccuracyFlagCounter: + type: integer + format: int32 + changeCounter: + type: integer + format: int32 + maxUpdatesVerificationCount: + type: integer + format: int32 + lastChangeDate: + type: string + format: date-time + isValidated: + type: boolean + additionalProperties: false + B2bAccessToken: + type: object + properties: + access_token: + type: string + nullable: true + expires_in: + type: integer + format: int32 + refresh_expires_in: + type: integer + format: int32 + refresh_token: + type: string + nullable: true + token_type: + type: string + nullable: true + not-before-policy: + type: integer + format: int32 + scope: + type: string + nullable: true + BE_ID: + type: string + nullable: true + additionalProperties: false + ByteReadOnlyMemory: + type: object + properties: + length: + type: integer + format: int32 + readOnly: true + isEmpty: + type: boolean + readOnly: true + span: + $ref: '#/components/schemas/ByteReadOnlySpan' + additionalProperties: false + ByteReadOnlySpan: + type: object + properties: + length: + type: integer + format: int32 + readOnly: true + isEmpty: + type: boolean + readOnly: true + additionalProperties: false + Data: + type: object + properties: + name: + type: string + nullable: true + birthdate: + type: string + nullable: true + photo: + type: string + nullable: true + additionalProperties: false + DecryptedData: + type: object + properties: + decryptedName: + type: string + nullable: true + decryptedBirthdate: + type: string + nullable: true + decryptedPhoto: + type: string + description: Base64 encoded photo + format: byte + nullable: true + additionalProperties: false + DecryptedPersonalData: + type: object + properties: + decryptedData: + $ref: '#/components/schemas/DecryptedData' + encryptedData: + $ref: '#/components/schemas/PersonalData' + additionalProperties: false + DeletePersonalDataResponse: + type: object + properties: + deletedAttributes: + type: array + items: + type: string + nullable: true + additionalProperties: false + EntityTagHeaderValue: + type: object + properties: + tag: + $ref: '#/components/schemas/StringSegment' + isWeak: + type: boolean + readOnly: true + additionalProperties: false + EphemeralKey: + type: object + properties: + ephemeralKeyAlias: + type: string + nullable: true + encryptedEphemeralKey: + type: string + nullable: true + additionalProperties: false + Error: + type: object + properties: + code: + type: string + nullable: true + data: + type: array + items: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + ErrorResponse: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + exceptionClassName: + type: string + nullable: true + exceptionStackTrace: + type: string + nullable: true + additionalProperties: false + FileContentHttpResult: + type: object + properties: + contentType: + type: string + nullable: true + readOnly: true + fileDownloadName: + type: string + nullable: true + readOnly: true + lastModified: + type: string + format: date-time + nullable: true + readOnly: true + entityTag: + $ref: '#/components/schemas/EntityTagHeaderValue' + enableRangeProcessing: + type: boolean + readOnly: true + fileLength: + type: integer + format: int64 + nullable: true + readOnly: true + fileContents: + $ref: '#/components/schemas/ByteReadOnlyMemory' + additionalProperties: false + Metadata: + type: object + properties: + encryptedEphemeralKey: + type: string + nullable: true + additionalProperties: false + OtpResponse: + type: object + properties: + maskedEmailAddress: + type: string + nullable: true + additionalProperties: false + PersonalData: + type: object + properties: + metadata: + $ref: '#/components/schemas/Metadata' + data: + $ref: '#/components/schemas/Data' + additionalProperties: false + StringSegment: + type: object + properties: + buffer: + type: string + nullable: true + offset: + type: integer + format: int32 + readOnly: true + length: + type: integer + format: int32 + readOnly: true + value: + type: string + nullable: true + readOnly: true + hasValue: + type: boolean + readOnly: true + additionalProperties: false + UserAccessToken: + type: object + properties: + accessToken: + type: string + nullable: true + additionalProperties: false From 2bdc65cba3a8931ef51c6d6e1d539f65ab0e4bfe Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 28 Jul 2025 16:23:16 +0200 Subject: [PATCH 4/4] fixed urls --- src/openapi/claims/claims-forms.yaml | 1 - src/openapi/contracts/contracts-se.yaml | 1 - src/openapi/customers/SE-customers.yaml | 1 - src/openapi/customers/customers-crud-v2.yaml | 1 - src/openapi/customers/customers.yaml | 1 - src/openapi/customers/customers_reference-crud.yaml | 1 - src/openapi/orders/SE-orders-gboAgeProfile.yaml | 1 - src/openapi/orders/service_engine_orders.yaml | 1 - src/openapi/products/SE-products-SE.yaml | 1 - src/openapi/products/SE-products-TP.yaml | 1 - 10 files changed, 10 deletions(-) diff --git a/src/openapi/claims/claims-forms.yaml b/src/openapi/claims/claims-forms.yaml index f2017dc..2404337 100644 --- a/src/openapi/claims/claims-forms.yaml +++ b/src/openapi/claims/claims-forms.yaml @@ -4,7 +4,6 @@ info: version: '1.0' servers: - url: https://services.acc.api.htm.nl/chipkaart/1.0 - - url: http://services.acc.api.htm.nl/chipkaart/1.0 security: - default: [] tags: diff --git a/src/openapi/contracts/contracts-se.yaml b/src/openapi/contracts/contracts-se.yaml index 3f898db..da96f7f 100644 --- a/src/openapi/contracts/contracts-se.yaml +++ b/src/openapi/contracts/contracts-se.yaml @@ -5,7 +5,6 @@ info: description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub. servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 - - url: https://services.api.htm.nl/abt/touchpoint/1.0 paths: /customers/contracts: parameters: diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index 003d0b8..1050f1a 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -7,7 +7,6 @@ info: version: "1.0" servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 - - url: http://services.acc.api.htm.nl/abt/touchpoint/1.0 tags: - name: Customers description: >- diff --git a/src/openapi/customers/customers-crud-v2.yaml b/src/openapi/customers/customers-crud-v2.yaml index d17bb5c..fd15fb1 100644 --- a/src/openapi/customers/customers-crud-v2.yaml +++ b/src/openapi/customers/customers-crud-v2.yaml @@ -5,7 +5,6 @@ info: description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine. servers: - url: https://services.acc.api.htm.nl/abt/abtcustomers/2.0 - - url: http://services.acc.api.htm.nl/abt/abtcustomers/2.0 paths: /customers: get: diff --git a/src/openapi/customers/customers.yaml b/src/openapi/customers/customers.yaml index 472250a..19d014e 100644 --- a/src/openapi/customers/customers.yaml +++ b/src/openapi/customers/customers.yaml @@ -4,7 +4,6 @@ info: version: '1.0' servers: - url: https://services.acc.api.htm.nl/abt/abtcustomers/1.0 - - url: http://services.acc.api.htm.nl/abt/abtcustomers/1.0 security: - default: [] tags: diff --git a/src/openapi/customers/customers_reference-crud.yaml b/src/openapi/customers/customers_reference-crud.yaml index d63b899..e3c5a7e 100644 --- a/src/openapi/customers/customers_reference-crud.yaml +++ b/src/openapi/customers/customers_reference-crud.yaml @@ -4,7 +4,6 @@ info: version: '1.0' servers: - url: https://services.acc.api.htm.nl/abt/customerreference/1.0 - - url: http://services.acc.api.htm.nl/abt/customerreference/1.0 security: - default: [] tags: diff --git a/src/openapi/orders/SE-orders-gboAgeProfile.yaml b/src/openapi/orders/SE-orders-gboAgeProfile.yaml index 95cfd7d..939ef57 100644 --- a/src/openapi/orders/SE-orders-gboAgeProfile.yaml +++ b/src/openapi/orders/SE-orders-gboAgeProfile.yaml @@ -5,7 +5,6 @@ info: description: Order APIs available in the Service Engine for order validation and fulfillment. servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0 - - url: https://services.api.htm.nl/abt/touchpoint/2.0 paths: /orders/validation/gboAgeProfile: get: diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 16c5ee0..3546a4c 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -5,7 +5,6 @@ info: description: Order APIs available in the Service Engine for order validation and fulfillment. servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0 - - url: https://services.api.htm.nl/abt/touchpoint/2.0 paths: /orders/validation: post: diff --git a/src/openapi/products/SE-products-SE.yaml b/src/openapi/products/SE-products-SE.yaml index bc29f13..943c2ee 100644 --- a/src/openapi/products/SE-products-SE.yaml +++ b/src/openapi/products/SE-products-SE.yaml @@ -7,7 +7,6 @@ info: version: "1.0" servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 - - url: https://services.api.htm.nl/abt/touchpoint/1.0 tags: - name: ServiceEngine Products description: |- diff --git a/src/openapi/products/SE-products-TP.yaml b/src/openapi/products/SE-products-TP.yaml index 6e89ae2..a8bf64b 100644 --- a/src/openapi/products/SE-products-TP.yaml +++ b/src/openapi/products/SE-products-TP.yaml @@ -7,7 +7,6 @@ info: version: "1.0" servers: - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0 - - url: https://services.api.htm.nl/abt/touchpoint/1.0 tags: - name: ServiceEngine Products description: |-