From a948411235424107a342cf9ba914a6afc5eab9fe Mon Sep 17 00:00:00 2001 From: Mina Moeini Date: Fri, 29 May 2026 11:30:06 +0200 Subject: [PATCH 1/2] extend posdealer api doc --- .gitignore | 1 + .../de/buy-resell/products/_notification.mdx | 73 +++++++++++++++++++ 2 files changed, 74 insertions(+) diff --git a/.gitignore b/.gitignore index e43b0f9..12e3668 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .DS_Store +.vs/ diff --git a/posdealers/_markets/de/buy-resell/products/_notification.mdx b/posdealers/_markets/de/buy-resell/products/_notification.mdx index 9ff38df..3551193 100644 --- a/posdealers/_markets/de/buy-resell/products/_notification.mdx +++ b/posdealers/_markets/de/buy-resell/products/_notification.mdx @@ -82,6 +82,79 @@ If the notification was successful, the operator receives a **confirmation email ![Confirmation Email](./images/ConfirmationEmail_DE.png) +## Trigger Notifications via API + +In addition to managing notifications through the portal, Dealers can trigger a notification for a specific Operator programmatically using the REST API. + +### Endpoint + +``` +POST api/notifications/de/triggermanually +``` + +:::tip sandbox + +A sandbox environment is available at `https://helipad-sandbox.fiskaltrust.cloud`. Use it to test requests before running them against the production system at `https://helipad.fiskaltrust.cloud`. + +::: + +### Authentication + +The request requires your Dealer account credentials passed as HTTP headers. + +| Header | Description | +|---------------|-----------------------------------------------------------------------------| +| `accountid` | Your Dealer account ID, found in the portal under `[COMPANYNAME]` / `Overview`. | +| `accesstoken` | Your Dealer account access token, found in the same location as the account ID. | + +### Request Body + +Send a JSON object containing the target Operator's account ID. + +| Field | Type | Description | +|-----------------|--------|----------------------------------------------------------| +| `posOperatorId` | string | The account ID of the PosOperator for whom the notification should be triggered. | + +**Example body** + +```json +{ + "posOperatorId": "POSOPERATOR_ACCOUNT_ID" +} +``` + +### Example Requests + +**curl** + +```shell +curl.exe -X POST \ + -H "Content-Type: application/json" \ + -H "accountid: ACCOUNT_ID" \ + -H "accesstoken: ACCOUNT_ACCESS_TOKEN" \ + -d '{"posOperatorId": "POSOPERATOR_ACCOUNT_ID"}' \ + https://helipad.fiskaltrust.cloud/api/notifications/de/triggermanually +``` + +**Invoke-WebRequest (PowerShell)** + +```powershell +$headers = @{ accountid = "ACCOUNT_ID"; accesstoken = "ACCOUNT_ACCESS_TOKEN" } +$body = '{"posOperatorId": "POSOPERATOR_ACCOUNT_ID"}' +Invoke-WebRequest ` + -Uri https://helipad.fiskaltrust.cloud/api/notifications/de/triggermanually ` + -Method Post ` + -Headers $headers ` + -Body $body ` + -ContentType application/json +``` + +### Response + +A status code of `200` confirms that the notification trigger was accepted for the specified Operator. Check the Notifications page in the portal to monitor the resulting notification status. + +--- + ## Troubleshooting & Support ### Common Problems From 870bfaae91d38ae9effe6004fe5445cb034ea16a Mon Sep 17 00:00:00 2001 From: Mina Moeini Date: Fri, 29 May 2026 11:55:47 +0200 Subject: [PATCH 2/2] clean up --- .../de/buy-resell/products/_notification.mdx | 20 ++++--------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/posdealers/_markets/de/buy-resell/products/_notification.mdx b/posdealers/_markets/de/buy-resell/products/_notification.mdx index 3551193..8e8dc25 100644 --- a/posdealers/_markets/de/buy-resell/products/_notification.mdx +++ b/posdealers/_markets/de/buy-resell/products/_notification.mdx @@ -92,12 +92,6 @@ In addition to managing notifications through the portal, Dealers can trigger a POST api/notifications/de/triggermanually ``` -:::tip sandbox - -A sandbox environment is available at `https://helipad-sandbox.fiskaltrust.cloud`. Use it to test requests before running them against the production system at `https://helipad.fiskaltrust.cloud`. - -::: - ### Authentication The request requires your Dealer account credentials passed as HTTP headers. @@ -109,18 +103,12 @@ The request requires your Dealer account credentials passed as HTTP headers. ### Request Body -Send a JSON object containing the target Operator's account ID. - -| Field | Type | Description | -|-----------------|--------|----------------------------------------------------------| -| `posOperatorId` | string | The account ID of the PosOperator for whom the notification should be triggered. | +Send the PosOperator's account ID as a plain JSON string in the request body. **Example body** ```json -{ - "posOperatorId": "POSOPERATOR_ACCOUNT_ID" -} +"POSOPERATOR_ACCOUNT_ID" ``` ### Example Requests @@ -132,7 +120,7 @@ curl.exe -X POST \ -H "Content-Type: application/json" \ -H "accountid: ACCOUNT_ID" \ -H "accesstoken: ACCOUNT_ACCESS_TOKEN" \ - -d '{"posOperatorId": "POSOPERATOR_ACCOUNT_ID"}' \ + -d '"POSOPERATOR_ACCOUNT_ID"' \ https://helipad.fiskaltrust.cloud/api/notifications/de/triggermanually ``` @@ -140,7 +128,7 @@ curl.exe -X POST \ ```powershell $headers = @{ accountid = "ACCOUNT_ID"; accesstoken = "ACCOUNT_ACCESS_TOKEN" } -$body = '{"posOperatorId": "POSOPERATOR_ACCOUNT_ID"}' +$body = '"POSOPERATOR_ACCOUNT_ID"' Invoke-WebRequest ` -Uri https://helipad.fiskaltrust.cloud/api/notifications/de/triggermanually ` -Method Post `