diff --git a/docs/details/callbacks.mdx b/docs/details/callbacks.mdx index b02f430d8c022c16d5eefce978b9139cd27cef44..11bf5e6ba89364880edb56039b6f74bf3daed25e 100644 --- a/docs/details/callbacks.mdx +++ b/docs/details/callbacks.mdx @@ -97,13 +97,24 @@ Um [Replay-Angriffe](https://de.wikipedia.org/wiki/Replay-Angriff) zu vermeiden, Dieser Timestamp wird im HTTP-Header `callback-timestamp` übertragen. Bei der Prüfung der Echtheit des ausgelösten Callbacks **MÜSSEN** API-Clients prüfen, dass der angegebene Timestamp nicht älter als **5 Minuten** ist. -Das folgende Beispiel zeigt die Verwendung der HTTP-Header `callback-authentication` und `callback-timestamp`: +Das folgende Beispiel zeigt die Verwendung der HTTP-Header `callback-authentication` und `callback-timestamp`. +Zu beachten ist, dass das Feld `submissionIds` als *deprecated* markiert wurde und durch das Feld `submissions` ersetzt werden soll. ```http POST /callbacks/fit-connect -callback-authentication: 798cd0edb70c08e5b32aa8a18cbbc8ff6b3078c51af6d011ff4e32e470c746234fc4314821fe5185264b029e962bd37de33f3b9fc5f1a93c40ce6672845e90df +callback-authentication: 2056b372b5bcec06d8f11ab79b84b42d6cbe1c8e1178cdfa36e4385dcf717758aaa7599f417d9ec3e079087884f4fd59680bf713621383e2d4414ef74fb10df3 callback-timestamp: 1672527599 -{"type":"https://schema.fitko.de/fit-connect/submission-api/callbacks/new-submissions","submissionIds":["f39ab143-d91a-474a-b69f-b00f1a1873c2"]} +{ + "type":"https://schema.fitko.de/fit-connect/submission-api/callbacks/new-submissions", + "submissionIds":["f39ab143-d91a-474a-b69f-b00f1a1873c2"], + "submissions":[ + { + "destinationId":"d12caea8-f372-4eb1-b102-b0a228253a11", + "submissionId":"f39ab143-d91a-474a-b69f-b00f1a1873c2", + "caseId":"9eec7d3e-dc66-4f82-9f52-1520bf96a32e" + } + ] +} ``` Der HMAC wird gebildet aus dem im HTTP-Header `callback-timestamp` übertragenen Zeitstempel und dem im HTTP-Body übertragenen Payload, getrennt durch das Zeichen `.` (Punkt), jeweils UTF-8-kodiert. Der HMAC wird hexadezimal kodiert übertragen. diff --git a/docs/receiving/notification.mdx b/docs/receiving/notification.mdx index 4f07ee177acc3c11303d27f2d14fc75a0bcdb5b4..4ae7926d1e8600291f02776c272143055020f441 100644 --- a/docs/receiving/notification.mdx +++ b/docs/receiving/notification.mdx @@ -12,14 +12,25 @@ Wenn ein Callback im Zustellpunkt hinterlegt ist, kann der Zustelldienst den Zus Das Format, in welchem der Callback übertragen wird, ist im Endpunkt <ApiLink api="submission-api" to="/v1/destinations/{destinationId}" withMethod="put" /> definiert. Die Konfiguration und Prüfung von Callbacks ist im Artikel [Verwendung von Callbacks](../details/callbacks.mdx) beschrieben. -Callbacks zur Benachrichtigung über neue Einreichungen haben das folgende Format: +Callbacks zur Benachrichtigung über neue Einreichungen haben aktuell das folgende Format. +Zu beachten ist, dass das Feld `submissionIds` als *deprecated* markiert wurde und durch das Feld `submissions` ersetzt werden soll. ```http POST /callbacks/fit-connect -callback-authentication: 7f87a283486dea1765b1fcfa0d5a868d78b58f7440a266c843bbe31b53364c5671d5f1aeaf38359ce121d3494f7cb12e9618a8d51c9339abf57b568c8baf5246 +callback-authentication: 2056b372b5bcec06d8f11ab79b84b42d6cbe1c8e1178cdfa36e4385dcf717758aaa7599f417d9ec3e079087884f4fd59680bf713621383e2d4414ef74fb10df3 callback-timestamp: 1672527599 -{"type":"https://schema.fitko.de/fit-connect/submission-api/callbacks/new-submissions","submissionIds":["f39ab143-d91a-474a-b69f-b00f1a1873c2"]} +{ + "type":"https://schema.fitko.de/fit-connect/submission-api/callbacks/new-submissions", + "submissionIds":["f39ab143-d91a-474a-b69f-b00f1a1873c2"], + "submissions":[ + { + "destinationId":"d12caea8-f372-4eb1-b102-b0a228253a11", + "submissionId":"f39ab143-d91a-474a-b69f-b00f1a1873c2", + "caseId":"9eec7d3e-dc66-4f82-9f52-1520bf96a32e" + } + ] +} ``` :::caution Warnung!