new infoplaza endpoint to send push notifications

This commit is contained in:
MirjamHTM committed 2026-09-30 10:38:36 +02:00
1 parent 65971e6210
commit 87fb9ccbd7
1 file changed
+78
@@ -0,0 +1,78 @@
openapi: "3.0.3"
info:
title: Infoplaza endpoints to send push notifications to customers
version: "1.0"
description: This the infoplaza endpoint for sending push notifcations, only available fo the Service Engine should not be available for Touchpoints.
servers:
- url: https://services.acc.api.htm.nl/abt/pushnotifications/1.0
paths:
/pushnotifications:
post:
summary: Create a new push notification message, based on an device or a specific customer (sub).
tags:
- Push notifications
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PostPushNotificationMessage"
examples:
pushnotificationdevice:
value:
type: "test-operator-device-message"
deviceId: "dCmmsMlQcpQiCsWOsJWQlEG7gfP2"
content: {
"translations": [
{ "language": "nl", "title": "Testmelding", "body": "Dit is een testmelding." },
{ "language": "en", "title": "Test notification", "body": "This is a test notification." }
]
}
pushnotificationcustomer:
value:
type: "test-operator-user-message"
iss: "https://htmnlb2cacc.b2clogin.com/27d8cb42-9f48-42be-a98a-276cf4d0e338/v2.0/"
sub: "a4c92fd3-c07a-40ae-8ba5-b1c592702c0d"
content: {
"translations": [
{ "language": "nl", "title": "Testmelding", "body": "Dit is een testmelding." },
{ "language": "en", "title": "Test notification", "body": "This is a test notification." }
]
}
responses:
"201":
description: Created
"400":
description: Bad request
"401":
description: Unauthorized
"404":
description: Not found
"500":
description: Internal server error
components:
schemas:
PostPushNotificationMessage:
type: object
required:
- type
- content
properties:
type:
type: string
example: "test-operator-device-message"
deviceId:
type: string
example: "dCmmsMlQcpQiCsWOsJWQlEG7gfP2"
iss:
type: string
example: "https://htmnlb2cacc.b2clogin.com/27d8cb42-9f48-42be-a98a-276cf4d0e338/v2.0/"
sub:
type: string
example: "a4c92fd3-c07a-40ae-8ba5-b1c592702c0d"
content:
type: object
properties:
translations:
type: array