HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 4 Actions Packages Projects Releases 1 Wiki Activity

Niceness

Browse Source
This commit is contained in:
Max Martens 2025-04-30 12:38:01 +02:00
parent 4c8032a4e0
commit 38b7e2240c
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/openapi/apim/TP-PAD.yaml
View File

@ -1,21 +1,21 @@
openapi: 3.0.1 openapi: 3.0.1
info: info:
title: Personal Account Data (PAD) APIs for TouchPoint title: Personal Account Data (PAD) APIs for touchpoints
description: >- description: |-
APIs for touchpoints to manage Personal Account Data (PAD) on OVpay tokens (xTATs).\
These APIs connect directly to the PADP APIs in GBO APIM and are implemented in Logic Apps These APIs connect directly to the PADP APIs in GBO APIM and are implemented in Logic Apps
in the Integration Layer. in the Integration Layer.
version: '1.0' version: '1.0'
servers: servers:
- url: https://api.integratielaag.nl/abt/touchpoint/1.0 - url: https://api.integratielaag.nl/abt/touchpoint/1.0
description: API ABT GBO APIM
tags: tags:
- name: Personal Data APIs for TouchPoint - name: Personal Data APIs for touchpoints
description: Personal Data APIs for TouchPoint, no Service Engine in between! description: Personal Data APIs for touchpoints, no Service Engine in between!
paths: paths:
/personal-data/{xtat}: /personal-data/{xtat}:
post: post:
tags: tags:
- Personal Data APIs for TouchPoint - Personal Data APIs for touchpoints
summary: Add the supplied Personal Data to the given xTAT (that should not contain any Personal Data yet). summary: Add the supplied Personal Data to the given xTAT (that should not contain any Personal Data yet).
description: |- description: |-
- The given xTAT should not contain any Personal Data yet (the PATCH endpoint should be used in that case) - if the given xTAT already contains Personal Data, an error is thrown; - The given xTAT should not contain any Personal Data yet (the PATCH endpoint should be used in that case) - if the given xTAT already contains Personal Data, an error is thrown;
@ -90,7 +90,7 @@ paths:
$ref: '#/components/schemas/ErrorResponse' $ref: '#/components/schemas/ErrorResponse'
get: get:
tags: tags:
- Personal Data APIs for TouchPoint - Personal Data APIs for touchpoints
summary: Retrieve the decrypted Personal Data for the given xTAT, using the OTP for verification of ownership. summary: Retrieve the decrypted Personal Data for the given xTAT, using the OTP for verification of ownership.
description: OTP challenge is required to retrieve the Personal Data. description: OTP challenge is required to retrieve the Personal Data.
operationId: GetDecryptedPersonalData operationId: GetDecryptedPersonalData
@ -137,7 +137,7 @@ paths:
$ref: '#/components/schemas/ErrorResponse' $ref: '#/components/schemas/ErrorResponse'
patch: patch:
tags: tags:
- Personal Data APIs for TouchPoint - Personal Data APIs for touchpoints
summary: Update the supplied personal data for the given xTAT, using the OTP for verification of ownership. summary: Update the supplied personal data for the given xTAT, using the OTP for verification of ownership.
description: This is a PATCH call, so only the personal data that the user desires to change need to be supplied. Integration layer supplements with any other existing personal data to be able to call GBO (PUT call). description: This is a PATCH call, so only the personal data that the user desires to change need to be supplied. Integration layer supplements with any other existing personal data to be able to call GBO (PUT call).
operationId: UpdatePersonalData operationId: UpdatePersonalData
@ -184,7 +184,7 @@ paths:
/personal-data/generate-otp: /personal-data/generate-otp:
get: get:
tags: tags:
- Personal Data APIs for TouchPoint - Personal Data APIs for touchpoints
summary: Trigger OTP email for the given xTAT or e-mail address, to prove ownership summary: Trigger OTP email for the given xTAT or e-mail address, to prove ownership
operationId: GenerateOtp operationId: GenerateOtp
description: |- description: |-