Zustellpunkte
Verwalten per API-Aufrufe
Diese Seite zeigt, wie Sie per API-Aufrufe Zustellpunkte ändern, anlegen, abfragen und löschen (verwalten). Sie können Zustellpunkte auch im Self-Service-Portal (SSP) verwalten. Die Seite Zustellpunkte erstellen beschreibt, wie Sie einen Zustellpunkt im SSP anlegen. Die Seite Zustellpunkte löschen zeigt, wie Sie im SSP einen Zustellpunkt löschen.
Voraussetzungen
Um einen Zustellpunkt per API-Aufruf zu verwalten, müssen die folgenden Voraussetzungen erfüllt sein.
- Subscriber-Client
Sie haben im Self-Service-Portal einen Client des Typs Subscriber angelegt. Die Seite Accountregistrierung und Client-Verwaltung beschreibt, wie Sie einen Client des Typs Subscriber erzeugen. - Destination Management API autorisiert
Beim Anlegen eines Clients haben Sie das optionale Feature aktiviert: Diesen Subscriber-Client zur Erstellung von Zustellpunkten über die Destination Management API autorisieren. - Client-ID und Client-Secret
Beim Anlegen des Subscriber-Clients wird die ID und das Secret des Clients angezeigt. Das Client-Secret wird nur beim Anlegen des Zustellpunktes gezeigt, danach nicht mehr. Sie müssen also das Client-Secret kopieren und speichern. - Access-Token
Die ID und das Secret dieses Clients benötigen Sie für den Aufruf des OAuth-Servers, um ein Access-Token zu erhalten, das Sie dazu berechtigt, per API-Aufruf auf diesen Client zuzugreifen. Sie erhalten das Token vom OAuth-Server, der für die jeweilige Umgebung von FIT-Connect zuständig ist. Die Seite Betriebsumgebungen der FIT-Connect-Infrastruktur beschreibt die Umgebungen und enthält für jede Umgebung die URLs für die einzelnen Dienste. Die Seite Authentifizierung beschreibt den Aufruf des OAuth-Servers, um ein Access-Token zu erhalten. - JWK-Token
Beim Aufruf des OAuth-Servers sendet der Server ein JSON-Object zurück, das unter der Eigenschaftaccess_token
ein Token im Format JWT (JSON Web Token) enthält. Speichern Sie das Token in einer Variablen. Die folgenden Beispiele verwenden dafür die VariableJWT_Token
. Ein JWT-Token beginnt zum Beispiel mit "eyJraWQiOiJHb2JOIi..."
Token sind nur für 30 Minuten gültig und müssen dann erneuert werden.
Zustellpunkt abfragen
Um die Eigenschaften eines Zustellpunkts zu erfragen, steht der folgende Endpunkt der Destination API zur Verfügung:
Die folgenden Beispiele rufen diesen Endpunkt auf,
um die Eigenschaften von Zustellpunkten zu erfragen,
die in der Testumgebung von FIT-Connect angelegt wurden.
Der Beginn des JWT-Tokens lautet in den Beispielen jeweils "eyJraWQiOiJHb2JOIi...".
Für den Abruf der Eigenschaften eines Zustellpunkts (mit der Destination-Id c984e28d-a342-45c8-9c95-1f8d29cab4b0)
lautet die vollständige URL dieses Endpunkts:
https:/test.fit-connect.fitko.dev/destination-api/v1/destinations/c984e28d-a342-45c8-9c95-1f8d29cab4b0
(siehe die folgenden Beispiele):
- curl
- JavaScript
$ DESTINATION_API=https://test.fit-connect.fitko.dev/destination-api
$ JWT_TOKEN=eyJraWQiOiJHb2JOIi...
$ DESTINATION_ID=c984e28d-a342-45c8-9c95-1f8d29cab4b0
# Eigenschaft einer Destination erfragen
$ curl -X GET \
-H "Accept: application/json" \
-H "Authorization: Bearer $JWT_TOKEN" \
$DESTINATION_API/v1/destinations/$DESTINATION_ID
Die Antwort des Endpunktes lautet:
{
"destinationId": "c984e28d-a342-45c8-9c95-1f8d29cab4b0",
"status": "active",
"services": [
{
"identifier": "urn:de:fim:leika:leistung:99001001000000",
"submissionSchemas": [
{
"schemaUri": "https://schema.fim.fitko.net/immutable/schemas/S00000096V1.0_2024-01-22-1705941843575.schema.json",
"mimeType": "application/json"
}
],
"regions": [
"DE01001"
],
"replyChannels": {
"eMail": {
"usePgp": false
}
}
}
],
"encryptionKid": "JXu78OPVZ4Vw3lRTnbotySG65n3JRyO3vlJZuywJzmo",
"contactInformation": {
"legalName": "Meine Gemeinde",
"address": "Meine Straße 1,82284,MeineStadt",
"phone": "0880762242",
"email": "info@meineemail.de",
"unit": "Standesamt"
},
"metadataVersions": [
"1.1.0"
]
}
const DESTINATION_API = 'https://test.fit-connect.fitko.dev/destination-api';
const DESTINATION_ID = 'c984e28d-a342-45c8-9c95-1f8d29cab4b0';
fetch(DESTINATION_API + '/v1/destinations/' + DESTINATION_ID,
{
method: 'GET',
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer eyJraWQiOiJHb2JOIi...',
}
})
.then(response => response.json())
.then(data => {
console.log(data);
});
Die Antwort des Endpunktes lautet:
{
destinationId: 'c984e28d-a342-45c8-9c95-1f8d29cab4b0',
name: 'MeinZustellpunkt',
status: 'active',
services: [
{
identifier: 'urn:de:fim:leika:leistung:99001001000000',
submissionSchemas: [Array],
regions: [Array]
}
],
encryptionKid: 'V_cZr3S2H9wlIiuhf9ESyVPBXM3S0-pChk9Ou3d_2tA',
contactInformation: {
legalName: 'MeineBehörde',
address: 'Meine Straße 1a,12345,MeineStadt',
phone: '01111366666',
email: 'info@meineStadt.de',
unit: 'MeinDezernat'
},
metadataVersions: [ '1.2.0' ]
}
Sie können die Eigenschaften eines Zustellpunktes über die folgenden APIs abfragen:
-
Destination API
Die können den EndpuntGET /v1/destinations/{destinationId}
an der Destination API aufrufen, wie die Beispiele oben zeigen (Aufrufe mit JavaScript und curl). -
Submission API
Sie können den EndpunktGET /v1/destinations/{destinationId}
aber auch an der Submission API aufrufen. Das folgende Beispiel zeigt den Aufruf mit dem Programm Postman. Beide Aufrufe liefern das selbe Ergebnis. Um den Aufruf zu sehen, klicken Sie auf die folgende Überschrift: "Mit Postman die Eigenschaften erfragen"
Das folgende Bild zeigt,
wie Sie die Eigenschaften eines Zustellpunktes erfragen,
indem Sie den API-Endpunkt GET /v1/destinations/{destinationId}
mit dem Programm Postman aufrufen.
Im Bild oben ist der Aufruf zu sehen,
im Bild unten die Antwort des Zustelldienstes:
Öffentliche Schlüssel abrufen
Um die öffentlichen Schlüssel eines Zustellpunkts zu erfragen, steht der folgende Endpunkt der Destination API zur Verfügung:
Die folgenden Beispiele rufen die öffentlichen Schlüssel eines Zustellpunktes ab,
das JSON Web Key Set (JWKS).
Der Beginn des JWT-Tokens lautet im Beispiel "eyJraWQiOiJHb...".
- JavaScript
const DESTINATION_API = 'https://test.fit-connect.fitko.dev/destination-api';
const DESTINATION_ID = 'c984e28d-a342-45c8-9c95-1f8d29cab4b0';
fetch(DESTINATION_API + `/v1/destinations/${DESTINATION_ID}/keys`,
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer eyJraWQiOiJHb2JOIiwidHlwIjoiYXQrand0IiwiYWxnIjoiRWR..',
}
})
.then(response => response.json())
.then(data => {
console.log(data);
});
Zustellpunkt anlegen
Um einen neuen Zustellpunkt anzulegen,
rufen Sie den Endpunkt POST /v1/destinations
der Destination-API auf.
Das folgende Beispiel zeigt,
wie Sie mit einem JavaScript-Programm diesen Endpunkt aufrufen,
um einen neuen Zustellpunkt anzulegen.
Das Beispiel enthält alle Daten,
die für einen erfolgreichen Aufruf erforderlich sind;
lediglich die Callback-URL wurde geändert.
In Ihrem Programm muss die Callback-URL aufgelöst werden können.
Zudem muss das Bearer-Token für einen Client für Ihr Verwaltungssystem erstellt worden sein,
dem Sie den neuen Zustellpunkt zuordnen wollen.
In der Dokumentation zur Destination API ist angegeben,
welche Daten für das Anlegen eines Zustellpunktes erforderlich sind.
Zudem ist dort ein Beispiel für die Daten zu sehen,
die für den Endpunkt POST /v1/destinations
erforderlich sind.
- JavaScript
fetch('https://test.fit-connect.fitko.dev/destination-api/v1/destinations', {
"method": "POST",
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Bearer eyJraWQiOiJHb2JOIiwidHlwIjoiYXQrand0IiwiYWxnIjoiRWREU0EifQ.eyJzdWIiOiJhZjMwZmE1Ni00NDkzLTRlMzgtODI5OC03Y2M1MzJkNTI0NjkiLCJhdWQiOiJodHRwczovL2ZpdC1jb25uZWN0LmZpdGtvLmRlLyIsInNjb3BlIjoiaHR0cHM6Ly9zY2hlbWEuZml0a28uZGUvZml0LWNvbm5lY3Qvb2F1dGgvc2NvcGVzL21hbmFnZS1kZXN0aW5hdGlvbnMgaHR0cHM6Ly9zY2hlbWEuZml0a28uZGUvZml0LWNvbm5lY3Qvb2F1dGgvc2NvcGVzL3N1YnNjcmliZS1kZXN0aW5hdGlvbnMgaHR0cHM6Ly9zY2hlbWEuZml0a28uZGUvZml0LWNvbm5lY3Qvb2F1dGgvc2NvcGVzL3NlbGYtc2VydmljZS1wb3J0YWwtYXBpL2NyZWF0ZTpkZXN0aW5hdGlvbiIsImlzcyI6Imh0dHBzOi8vYXV0aC10ZXN0aW5nLmZpdC1jb25uZWN0LmZpdGtvLmRldiIsImV4cCI6MTczNzcxNDQzNywiaWF0IjoxNzM3NzEyNjM3LCJqdGkiOiJ3TV9mOVRVa2hsQSIsImNsaWVudF9pZCI6ImFmMzBmYTU2LTQ0OTMtNGUzOC04Mjk4LTdjYzUzMmQ1MjQ2OSJ9.79jzepb_dN6KiTFJN1BoUaLKpVq9L-ZvSHraOkG7o2bhWp6rO338zdypYsQl2qEVoEhklOGmH9QvbVh55HGmAA',
},
'body' : JSON.stringify({
"name": "Bürgeramt Berlin",
"contactInformation": {
"legalName": "Max",
"address": "Musterstraße 12,12345,Musterstadt",
"phone": "+49170123456789",
"email": "max@mustermann.not",
"unit": "Department XYZ"
},
"services": [
{
"identifier": "urn:de:fim:leika:leistung:99010003001006",
"submissionSchemas": [
{
"schemaUri": "https://schema.fim.fitko.net/immutable/schemas/S00000121V1.0_2024-01-22-1705941957653.schema.json",
"mimeType": "application/json"
}
],
"regions": [
"DE094750156156",
"DE09330411"
]
}
],
"callback": {
"url": "https://meine_callback_url.com",
"secret": "insecure_unsafe_qHScgrg_kP-R31jHUwp3GkVkGJolvBchz65b74Lzue0"
},
"encryptionKid": "DpwGn3IMAJUxf4FMexstOb7d5aMZe6ETaTrEUiaUDMI",
"encryptionPublicKey": {"alg":"RSA-OAEP-256","e":"AQAB","key_ops":["wrapKey"],"kid":"DpwGn3IMAJUxf4FMexstOb7d5aMZe6ETaTrEUiaUDMI","kty":"RSA","n":"2Q4VpcsaVHjgABOHNz56wSN5XUWdnd686GuTXZbhd6mIEpwIOYx6Fu5y8rZN98yvv83aYaqjVFpOtS2KL7pp03CKmZXxGHSZwnsGTLJfJsCdxlJTGhp8nCeLaeT4tpSJsN3L1NyQ_cXLETEKy6_R5B2_ODlv0Q08-0oNTD8qskHhAtC5JCADLe5r_xWdnXFaSUNg6Gxhbai2tZX8pAuXG7b48Q6nEsXf7fbRxb-UVPsl2aBjQ16JP4cRPWhdgwrzOihdQg7g8jqBwT7bmUmiPE92BT8TaYA_AXUK5-fPCzjnRvKDLca7gixkfr8eWoJOgY4D9-T9r-mBLkS4vgKtRq0L-uNSETB5s8259K1jaKTavrtITuJkPV8ubOv1js9rRc1EDGHfNdphpWS99riz55_ljmnoYRLo0ZxkjUfIgoj3cYJJFS1unYUWACvHY11hQ_b9_lHuRm9ySxE1NSjcijWPBeWhHnPIRqWp5qKzybZU33fWyDMaDRCb48RasgLZRKtWaiDFzjajd9vANIKquVoUbQx3gEGfLu07wpNBSaz9rK856elB_ySOF0xq9sEmlRb0gspRqOUR-6bWfcOTCAqGLXHxPfGmAQ0PXWbIGvYedIJ0toDkllvuVoqhXNQwSKyynhX4RvC8dqg00jxdb6FY7Gf1jdPYbhP1JhfyWNk","x5c":["MIIFCTCCAvECBARijrUwDQYJKoZIhvcNAQENBQAwSTELMAkGA1UEBhMCREUxFTATBgNVBAoMDFRlc3RiZWhvZXJkZTEjMCEGA1UEAwwaRklUIENvbm5lY3QgVGVzdHplcnRpZmlrYXQwHhcNMjUwMTIzMTEzMjAyWhcNMzUwMTIxMTEzMjAyWjBJMQswCQYDVQQGEwJERTEVMBMGA1UECgwMVGVzdGJlaG9lcmRlMSMwIQYDVQQDDBpGSVQgQ29ubmVjdCBUZXN0emVydGlmaWthdDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANkOFaXLGlR44AAThzc+esEjeV1FnZ3evOhrk12W4XepiBKcCDmMehbucvK2TffMr7/N2mGqo1RaTrUtii+6adNwipmV8Rh0mcJ7BkyyXybAncZSUxoafJwni2nk+LaUibDdy9TckP3FyxExCsuv0eQdvzg5b9ENPPtKDUw/KrJB4QLQuSQgAy3ua/8VnZ1xWklDYOhsYW2otrWV/KQLlxu2+PEOpxLF3+320cW/lFT7JdmgY0NeiT+HET1oXYMK8zooXUIO4PI6gcE+25lJojxPdgU/E2mAPwF1Cufnzws450bygy3Gu4IsZH6/HlqCToGOA/fk/a/pgS5EuL4CrUatC/rjUhEwebPNufStY2ik2r67SE7iZD1fLmzr9Y7Pa0XNRAxh3zXaYaVkvfa4s+ef5Y5p6GES6NGcZI1HyIKI93GCSRUtbp2FFgArx2NdYUP2/f5R7kZvcksRNTUo3Io1jwXloR5zyEalqeais8m2VN931sgzGg0Qm+PEWrIC2USrVmogxc42o3fbwDSCqrlaFG0Md4BBny7tO8KTQUms/ayvOenpQf8kjhdMavbBJpUW9ILKUajlEfum1n3DkwgKhi1x8T3xpgEND11myBr2HnSCdLaA5JZb7laKoVzUMEissp4V+EbwvHaoNNI8XW+hWOxn9Y3T2G4T9SYX8ljZAgMBAAEwDQYJKoZIhvcNAQENBQADggIBAMn+LDksAfPm68DzDmQl/G/Cp09F5GxeISOffQlTXkm7GQ3ntmhgb/+1EmIj1G/qX7+m6EoDYJ4gEc4UmndhjDA/P5i7J9Yw8YnkIhGer20mdMxXSb9kP7VQHgBKdIss/9V12plh2yFybyUhBDpu1ihTvSJae3FpzwB+wMZQX2MRrtPWexwzR0Ue/NNcUZ0hRAtQzs2KnPjq0DQBm99/z1Bzi+8jBfnMc5p5oG+Ad0lnnxOrCkqT/VUo9BMG1nqoU9Hr+0s7SxmQ4koQ+oE6vCN+xwdJ+78hdx0OdYYpVQ6vxbdePDH9l820Q1xXD16f/yWwQ/eS45S+MU53dFdIi96+64afB/bOpdvPMoGTm3WCFtYNKRdJkOf62fmIUxnYKuu97+pnMf7QrZw46rc1dCW1/dsYHTiEEDpNZP2AKLnn4gioTXA+KKh551A+OKwqgYTvC8fqGo/jJreMQf0mOc2jc3lPQR6Ol4u+j4TC3e+wUuEZ9xnG8W6E6eV3OmVH++iLmmnpWGG9zhA+vfXmu9oW0UJVCpKmEFyzyvjN+G4uP9zuURX31vjwv3onhAmdu4DIAQSj93EdZp6x11ls/D53rgRWJ9zGs4zi3MX4LDqDm/a2Nth5EPs+BYHsU/ssIDjY8AIUT1lxfzjJO4yktrj4DYCXhSyH9S9CrdZSEXgz"]},
"signingPublicKey": {"alg":"PS512","e":"AQAB","key_ops":["verify"],"kid":"xDJ7l_LZjgFyTQ07QV37a2A5b9UdmPK8CqKLuRtpCpE","kty":"RSA","n":"oMdaY3b0gIO-Kd3vDMjuh07Y_dbqwUNTImpNSaR1MznoKhnimOl7ZnYccypYnOzQV3XcUyoVJ9ZEYCpuj0d3PKnxcfywnWqustgAn5qWXtPFEK1xz0NuhbkXIa2eIOGLlisJ6Fz_BkpfPIuLsfSP6BHMnOoNZBnfX1IBDxzsdcNZB51ts8rS6CVGw8FamgrsbZB3XKc_0hk-JvvfEiSuch8K6yEU88WwR-JLs-AiJZo7lTf_ZKHesf7enwBh2Uv9FqN4zLKdDQHkdYXxyCol0yrSTxJtmVuCIkVrZdOUDsehi3rau3K6P8t9rcnsQFkRW8gzKz-mtzD8F65qkKBjPTdhiJ5X0oGH0sG3-KcUZaZ8BVWVHYXOaC_ia4AB-HQyljXJvcsLnNxnBHO1E3bmU0QdMekLUVFHHI1Q06m8NKgepqvNZ_mpEdV278cyYUeXDaPL9X2zjIKRdXzParRfRC1Jzt97tdjPoeNnma1fiFUUqJ9qhBTAxkjnBdQIOBMvB3pVPk6ZHg7QcTpDDd5x1BTKl-4iLzBO020j8G4KegZBfZNcuekjz0r7UPSfWzOucbBGLIltQHd4eTJ3vcYIoYFhvPPIcqYuARB6Vv9wISWCxABNFGQwAcPIHDfpPBdtupeFhNB-hhnbJyelP5LfONbMfpyV3lqQMp5eqwTw1Ks","x5c":["MIIFCTCCAvECBAWErBMwDQYJKoZIhvcNAQENBQAwSTELMAkGA1UEBhMCREUxFTATBgNVBAoMDFRlc3RiZWhvZXJkZTEjMCEGA1UEAwwaRklUIENvbm5lY3QgVGVzdHplcnRpZmlrYXQwHhcNMjUwMTIzMTEzMjA0WhcNMzUwMTIxMTEzMjA0WjBJMQswCQYDVQQGEwJERTEVMBMGA1UECgwMVGVzdGJlaG9lcmRlMSMwIQYDVQQDDBpGSVQgQ29ubmVjdCBUZXN0emVydGlmaWthdDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAKDHWmN29ICDvind7wzI7odO2P3W6sFDUyJqTUmkdTM56CoZ4pjpe2Z2HHMqWJzs0Fd13FMqFSfWRGAqbo9Hdzyp8XH8sJ1qrrLYAJ+all7TxRCtcc9DboW5FyGtniDhi5YrCehc/wZKXzyLi7H0j+gRzJzqDWQZ319SAQ8c7HXDWQedbbPK0uglRsPBWpoK7G2Qd1ynP9IZPib73xIkrnIfCushFPPFsEfiS7PgIiWaO5U3/2Sh3rH+3p8AYdlL/RajeMyynQ0B5HWF8cgqJdMq0k8SbZlbgiJFa2XTlA7HoYt62rtyuj/Lfa3J7EBZEVvIMys/prcw/BeuapCgYz03YYieV9KBh9LBt/inFGWmfAVVlR2Fzmgv4muAAfh0MpY1yb3LC5zcZwRztRN25lNEHTHpC1FRRxyNUNOpvDSoHqarzWf5qRHVdu/HMmFHlw2jy/V9s4yCkXV8z2q0X0QtSc7fe7XYz6HjZ5mtX4hVFKifaoQUwMZI5wXUCDgTLwd6VT5OmR4O0HE6Qw3ecdQUypfuIi8wTtNtI/BuCnoGQX2TXLnpI89K+1D0n1szrnGwRiyJbUB3eHkyd73GCKGBYbzzyHKmLgEQelb/cCElgsQATRRkMAHDyBw36TwXbbqXhYTQfoYZ2ycnpT+S3zjWzH6cld5akDKeXqsE8NSrAgMBAAEwDQYJKoZIhvcNAQENBQADggIBAB1S+jBAZwELuWXVMnPNP0B3jJHzkU0mXpRF9T0/gZr50d7B//TevIdA+HFtTVAR/MLl7qweHyhbZ1HdvhFYLLgO9LDVjpJt9iPIG1kiqqCVLfmzF8LOkFRoYvE8wFsMnc+8vY8PQlI8v9N9i9HrcuXV8lOsqMBx6hOWW8dhGmMsw3dhK9tkVsBjCB2jGmJLD6ewFIm4iDEjAislbiK7vfd9iee18EBWJXkfaREX5teq/OhL3yUxQPQy4cykqqAm341eEdzsXsiW4geJ7/+J6+HwaSuLnFNja6ayYzyYy9Q2lCrks/Hyupkz5zyiLNjcGLrKuN2MheANMf7gEYWwNK5yjgd1Qgsz/Jdfjc2KL0HGlyqq0oPHm8Y6IhR59MmXOQEXQqoboDHc0nxAn7YvvzVokb+Qt1JEBCfv6ztbE66csr19vkipPvxUQtIBsq8+XpaOzVUQ0XwYhvo0NJSD1IHNfrqNuAvbGj3QYCHH3CRcvS65maWNkkf/PNtJ1pl8KAZQimyDtHhSf+qEw9H/i7g3Nuh65t182Qu5pTZ3p7BMMPrGDMTqoGy03zyvUFLRYDbzyRyVnmj7JlTxgU1k2ZUd+YBmaJI7UBClfvogKy25SiGQcuA0RBBJj2wdoS/bBVJ+6kpEaZwbJdkdWfOe+/eaGgdb3J1gDZUDRnxcJz0s"]},
"metadataVersions": [
"1.0.1",
"2.1.1"
]
})
})
.then((response) => response.text())
.then((body) => {
console.log(body);
});
Zustellpunkte ändern
Zum Ändern und Aktualisieren eines Zustellpunktes stehen die folgenden Endpunkte der Destination API zur Verfügung:
- Vollständige Aktualisierung eines Zustellpunktes:
PUT /v1/destinations/{destinationId}
- Partielle Aktualisierung eines Zustellpunktes:
PATCH /v1/destinations/{destinationId}
Für die Aktualisierung der Schlüssel des Zustellpunktes gibt es den folgenden Endpunkt der Destination API:
Die Details sind der API-Spec zu entnehmen. Eine Beschreibung der Parameter des Zustellpunkt-Objektes finden Sie auf der Seite Aufbau der Zustellpunkt-Informationen.
Aktualisierung des Verschlüsselungsschlüssels eines Zustellpunktes
$ DESTINATION_API=https://test.fit-connect.fitko.dev/destination-api
$ JWT_TOKEN=eyJraWQiOiJHb2JOIiwidHlwIjoiYXQrand0...
$ DESTINATION_ID=d2bf7cf7-2625-4737-974f-0dd2054f8c6f
# Hinzufügen eines Schlüssels zu einer Destination
$ curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $JWT_TOKEN" \
--data '{"kty": "RSA", "kid": "new-encryption-key", "alg": "RSA-OAEP-256", "key_ops": ["wrapKey"], "x5c": ["..."], "e": "AQAB", "n": "..."}' \
"$DESTINATION_API/v1/destinations/$DESTINATION_ID/keys"
# Setzen der Schlüssel-ID als Verschlüsselungsschlüssel
$ curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $JWT_TOKEN" \
--data '{"encryptionKid": "new-encryption-key"}' \
"$DESTINATION_API/v1/destinations/$DESTINATION_ID"
Zustellpunkt löschen
Sie können Zustellpunkte löschen,
indem Sie den Endpunkt DELETE /v1/destinations/{destinationId}
aufrufen.
Das folgende Beispiel löscht den Zustellpunkt mit der Destination-Id
c3f1ae54-3844-48a5-8ea3-42db8897120f (siehe Beispiel für curl):
- curl
- JavaScript
$ DESTINATION_API=https://test.fit-connect.fitko.dev/destination-api
$ JWT_TOKEN=eyJraWQiOiJHb2JOIiwidHlwIjoiYXQrand0...
$ DESTINATION_ID=c3f1ae54-3844-48a5-8ea3-42db8897120f
# Löschen einer Destination
$ curl -X DELETE \
-H "Authorization: Bearer $JWT_TOKEN" \
"$SUBMISSION_API/v1/destinations/$DESTINATION_ID"
const ACCESS_TOKEN='eyJraWQiOiJHb2JOIiwidHlw.......';
const DESTINATION_API = 'https://test.fit-connect.fitko.dev/destination-api';
const DESTINATION_ID = 'c984e28d-a342-45c8-9c95-1f8d29cab4b0';
fetch(DESTINATION_API + '/v1/destinations/' + DESTINATION_ID,
{
method: 'DELETE',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${ACCESS_TOKEN}`,
}
})
.then(response => response.json())
.then(data => {
console.log(data);
});
Sie können Endpunkte nur unter bestimmten Bedingungen löschen. Beachten Sie bitte die Seite Bedingungen fürs Löschen, sie beschreibt, wann Zustellpunkte löschen werden können.
Status des Zustellpunkts ändern
Sie können den Status eines Zustellpunkts ändern,
indem Sie den Endpunkt PATCH /v1/destinations/{destinationId}
der Destination API aufrufen.
Das folgende Beispiel setzt den Status eines Endpunkts auf "active".
- curl
- JavaScript
$ DESTINATION_API=https://test.fit-connect.fitko.dev/destination-api
$ JWT_TOKEN=...
$ DESTINATION_ID=...
# Aktivieren einer Destination
$ curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $JWT_TOKEN" \
--data '{"status": "active"}' \
"$DESTINATION_API/v1/destinations/$DESTINATION_ID"
const DESTINATION_API = 'https://test.fit-connect.fitko.dev/destination-api';
const DESTINATION_ID = 'c984e28d-a342-45c8-9c95-1f8d29cab4b0';
const ACCESS_TOKEN='eyJraWQiOiJHb2JOIiwidHlwIjoiYXQrand0Iiwi...';
const changeStatus = {
"status": "active"
};
fetch(`${DESTINATION_API}/v1/destinations/${DESTINATION_ID}`,
{
method: 'PATCH',
body: JSON.stringify(changeStatus),
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${ACCESS_TOKEN}`
}
})
.then(response => response.json())
.then(data => {
console.log(data);
});
Wartefrist vor dem Wechsel von inactive
zu decommissioned
Wird ein Zustellpunkt in den Status decommissioned
versetzt, so kann er nicht mehr reaktiviert werden.
Daher wurde eine Wartefrist von 30 Tagen im Status inactive
vorgesehen.
Erst nach Ablauf dieser Zeit kann er in den Status decommissioned
versetzt werden.