{ "item": [ { "id": "aff493b3-052c-48c4-a570-7f2bc068647c", "name": "IntegrationCodelists", "description": { "content": "Reading the code lists the surface accepts and returns.", "type": "text/plain" }, "item": [ { "id": "91435ac8-5786-4c45-bc7a-b7189ffb77f3", "name": "Returns the active entries of one code list.", "request": { "name": "Returns the active entries of one code list.", "description": { "content": "These are the very values used internally, read for the tenant's UJP environment. A new\r\nentry appearing in a code list is not a breaking change.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "64a443d1-4e00-45a0-bcb6-f72575ec4268", "name": "The requested type and its active entries.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"string\",\n \"items\": [\n {\n \"code\": \"string\",\n \"name\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a82a2fe-a6ee-41f5-9a2d-1be7a340c884", "name": "`EARH-2021` — unknown code list type; the response lists the supported ones. Checked before\r\nthe tenant or the lookup service is touched.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a502f8-a24a-49e5-bd84-08552eb43b9c", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e0363b-9301-4b1f-b41b-596d8df1665f", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "335fa870-fc94-4a38-9945-194e3619efff", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b65d83-e935-4b03-80a0-f7b2386999d4", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "codelists", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "type", "description": "(Required) One of the eleven supported code list types." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b5409f21-691c-4fb3-9d4d-d1592733ee1c", "name": "IntegrationInbound", "description": { "content": "Pulling inbound documents and acknowledging that they were taken over.", "type": "text/plain" }, "item": [ { "id": "722cf9fa-ef0d-4f40-b5d2-c1f3ad4319a0", "name": "Lists inbound documents, newest first.", "request": { "name": "Lists inbound documents, newest first.", "description": { "content": "With `onlyNotImported=true` only documents that have not been acknowledged yet are returned.\r\nWithout the filter the acknowledged ones come back too, each with a visible `ackedAt`.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z", "description": "Lower bound on arrival time; omit for no lower bound." }, { "disabled": false, "key": "dateTo", "value": "1962-03-25T00:49:57.103Z", "description": "Upper bound on arrival time; omit for no upper bound." }, { "disabled": false, "key": "senderEdb", "value": "string", "description": "Tax number of the sender." }, { "disabled": false, "key": "onlyNotImported", "value": "true", "description": "When true, only documents without an acknowledgement." }, { "disabled": false, "key": "page", "value": "39", "description": "1-based page index; defaults to 1." }, { "disabled": false, "key": "pageSize", "value": "39", "description": "Documents per page; defaults to 100, maximum 500." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bb726b3c-3f5b-4795-aea1-d48f7e16cafb", "name": "The page of documents; an empty result is 200 with `totalCount` 0.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"docUid\": \"string\",\n \"receivedAt\": \"2009-04-08T21:13:32.254Z\",\n \"senderName\": \"string\",\n \"senderEdb\": \"string\",\n \"ackedAt\": \"1996-03-31T11:09:56.340Z\"\n },\n {\n \"docUid\": \"string\",\n \"receivedAt\": \"1965-10-14T14:55:12.781Z\",\n \"senderName\": \"string\",\n \"senderEdb\": \"string\",\n \"ackedAt\": \"1983-04-26T14:25:02.283Z\"\n }\n ],\n \"totalCount\": 2723,\n \"page\": 1429,\n \"pageSize\": 6467,\n \"totalPages\": 3706\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c1c837-fb01-4df4-bcf5-383452dae988", "name": "`EARH-3005` — the requested page size exceeds the allowed one; the response names it.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e606dd2a-6c41-4669-a4d4-40679073321b", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "792656fa-1329-4c47-a37e-c40a0f15fad3", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb66c0a-6d3b-49a0-811b-d53af37d3c7e", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac400bd5-3e9b-498d-870f-e73936bdd654", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "senderEdb", "value": "string" }, { "key": "onlyNotImported", "value": "true" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8928ef92-b4ba-4412-97e1-1e892b7650fd", "name": "Returns one inbound document by its identifier.", "request": { "name": "Returns one inbound document by its identifier.", "description": {}, "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "812e72df-2406-4475-a948-c8ae967c0d48", "name": "The document, including `ackedAt` when it was acknowledged.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"receivedAt\": \"2024-01-04T01:05:28.862Z\",\n \"senderName\": \"string\",\n \"senderEdb\": \"string\",\n \"ackedAt\": \"2023-02-24T05:13:12.290Z\",\n \"documentNumber\": \"string\",\n \"amount\": 8436.278397439337,\n \"currency\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8f039c2-2754-484d-9762-f99aab03cfd4", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228cdb1c-a572-4b7d-880a-18e122ad112c", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2018a1eb-5d32-4332-bd1e-fff9366fd6c3", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b0043c2-dd01-4960-ae81-a0e9e6abf0f8", "name": "`EARH-3001` — no such document. An unknown identifier and a document belonging to another\r\ntenant give an identical answer.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ec00aa-4d6d-4e01-9c61-932ac82df214", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a270d1-9dac-4c5f-afa9-05246a0370ff", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document, as it appears in the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dbc19a9b-2be0-494b-9191-8dded0831837", "name": "Downloads one representation of an inbound document.", "request": { "name": "Downloads one representation of an inbound document.", "description": { "content": "`original` is always available — the file exactly as it arrived. `ubl` and `pdf` are served\r\nonly if the document arrived in that shape; a representation is never produced on demand.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "string", "description": "One of `original`, `ubl`, `pdf`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "a2c77563-8c3f-46c0-8aed-18630d78e38d", "name": "The stored bytes of the requested representation.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6f7a793-e9c8-471f-a05d-a3167218040d", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e8d32c1-baf8-434b-9bfc-451fcb80a5a4", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdd741a4-5da2-4573-b2f0-b0de6f7662e3", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a369d7a3-1ca6-4f0b-961c-29a369385285", "name": "`EARH-3001` — no such document; `EARH-3002` — the document exists but did not arrive in that\r\nshape. `original` keeps working in that case.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e945141b-35ef-490f-b852-782e81e0ce09", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea0efde-598d-4581-94eb-a581f3bf633a", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4745815f-fd7c-4fc4-b3d9-8c64ac9fa272", "name": "Acknowledges that an inbound document was taken over.", "request": { "name": "Acknowledges that an inbound document was taken over.", "description": { "content": "The document then stops appearing under `onlyNotImported=true`. Acknowledging again is not\r\nan error: the time of the first acknowledgement is returned unchanged. There is no way to\r\ntake an acknowledgement back in `v1`, and the acknowledgement tells the sender nothing.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "47a0eb14-2fcc-4de8-8417-5aa9db2ee7dd", "name": "The acknowledgement stands; `ackedAt` is the time of the first one.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"ackedAt\": \"1991-03-22T08:06:50.942Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a676202b-5f81-4df7-91ac-ee070d707cf9", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f91c66-d85e-4ac7-a2f1-b3f6ed2de481", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74d45acb-6bfb-418b-b9ab-a67391656460", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "841df7f0-aace-4657-956a-b3b7daa9f751", "name": "`EARH-3001` — no such document. An unknown identifier and a document belonging to another\r\ntenant give an identical answer.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4986a93d-e2e2-4fae-a451-5c2f3c7df546", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a352c95-f434-4697-a3c0-426615bd4095", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "inbound", ":docUid", "ack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document being acknowledged." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "30035bf4-3145-4c6a-a992-67a2dd1c9c7e", "name": "IntegrationOutbound", "description": { "content": "Submitting outbound documents and following what happens to them.", "type": "text/plain" }, "item": [ { "id": "8338793b-1724-4144-99cf-14c35ef0513a", "name": "Submits one UBL 2.1 document for delivery.", "request": { "name": "Submits one UBL 2.1 document for delivery.", "description": { "content": "The response does not wait for processing: status `10` means \"received by us\". Repeating the\r\ncall with the same `X-Idempotency-Key` and the same body within one hour returns the same\r\n`docUid` with HTTP 200 instead of creating a second document.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "response": [ { "id": "cec07b7f-b0db-4a60-8562-39bd3104c3cb", "name": "The same key and body were already submitted; the original `docUid` is returned and\r\n`alreadyExisted` is `true`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"status\": 3593,\n \"receivedAt\": \"2017-04-29T03:49:10.129Z\",\n \"alreadyExisted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39995596-365f-4d0b-ad42-fabaa9584f04", "name": "The document was accepted and now carries a `docUid`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"status\": 3593,\n \"receivedAt\": \"2017-04-29T03:49:10.129Z\",\n \"alreadyExisted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec3b31a-6701-4d48-b646-062c1a58355d", "name": "The submission cannot be processed — `EARH-1007` (a tenant value in the body),\r\n`EARH-2001` (not well-formed XML), `EARH-2002` (not UBL 2.1), `EARH-2003` (no recipient),\r\n`EARH-2004` (malformed recipient tax number), `EARH-2005` (no document type),\r\n`EARH-2006` (no amount), `EARH-2011` (more than one document),\r\n`EARH-2013` (the `X-Idempotency-Key` header is missing).", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a217a1-4bf6-4552-ac89-3c666e42a648", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5cd10d9-3d96-42a7-a528-7b3e8cf53979", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2eaa96b-d816-4210-b4aa-af115911c427", "name": "`EARH-2010` — the same idempotency key was already used with different content;\r\n`EARH-9001` — outbound over the API is not enabled for this tenant.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e84bb2-9a1c-423b-bf10-2e8180c94e4e", "name": "`EARH-2012` — the document exceeds the working size limit; the response names the allowed one.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "994a0ef4-2a8a-4a95-af4d-e9ad5d171575", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9180ba-9e12-43b1-a9b8-f2471a6163ef", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "disabled": false, "description": "(Required) Client-chosen key that makes the submission repeatable. The same key with the same body within one hour returns the same docUid instead of creating a second document; the same key with a different body is rejected with EARH-2010. Missing means EARH-2013.", "key": "X-Idempotency-Key", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "\n(string)", "options": { "raw": { "language": "xml" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6917846d-abfd-4900-bfbe-302294392c86", "name": "Lists outbound documents, newest first.", "request": { "name": "Lists outbound documents, newest first.", "description": { "content": "The order is by creation time descending, and by identifier when two documents share the\r\nsame time — independent of the filter and of the page size. Documents created before the\r\nintegration surface existed carry no `docUid` and are neither returned nor counted.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z", "description": "Lower bound on creation time; omit for no lower bound." }, { "disabled": false, "key": "dateTo", "value": "1962-03-25T00:49:57.103Z", "description": "Upper bound on creation time; omit for no upper bound." }, { "disabled": false, "key": "status", "value": "377", "description": "Numeric status codes; repeat the parameter for more than one." }, { "disabled": false, "key": "status", "value": "2957", "description": "Numeric status codes; repeat the parameter for more than one." }, { "disabled": false, "key": "partnerEdb", "value": "string", "description": "Tax number of the recipient." }, { "disabled": false, "key": "page", "value": "39", "description": "1-based page index; defaults to 1." }, { "disabled": false, "key": "pageSize", "value": "39", "description": "Documents per page; defaults to 100, maximum 500." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4d742aaa-c465-4d01-8868-8721a5443f3a", "name": "The page of documents; an empty result is 200 with `totalCount` 0.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"docUid\": \"string\",\n \"status\": 6140,\n \"createdAt\": \"1975-07-15T18:57:37.673Z\",\n \"partnerEdb\": \"string\",\n \"documentNumber\": \"string\",\n \"amount\": 3332.8330108812743,\n \"currency\": \"string\"\n },\n {\n \"docUid\": \"string\",\n \"status\": 6071,\n \"createdAt\": \"1982-03-19T05:44:36.057Z\",\n \"partnerEdb\": \"string\",\n \"documentNumber\": \"string\",\n \"amount\": 7052.635791797773,\n \"currency\": \"string\"\n }\n ],\n \"totalCount\": 4140,\n \"page\": 677,\n \"pageSize\": 9379,\n \"totalPages\": 407\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd9b6e0-82b8-4d6d-a738-c69bff7a913d", "name": "`EARH-3005` — the requested page size exceeds the allowed one; the response names it.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8619f577-b2d7-4bd4-b591-8719573e6f63", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24dca2c3-166c-45a0-8750-206e55b05c6c", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3d77c42-178a-4499-bed8-4cd93a269b5d", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f565d47-4044-4463-aff2-db8d7c9c05f3", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "1962-03-25T00:49:57.103Z" }, { "key": "dateTo", "value": "1962-03-25T00:49:57.103Z" }, { "key": "status", "value": "4217" }, { "key": "status", "value": "6035" }, { "key": "partnerEdb", "value": "string" }, { "key": "page", "value": "39" }, { "key": "pageSize", "value": "39" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2de271ce-cda8-4d5d-bdb2-0776aa2f8729", "name": "Returns one outbound document by its identifier.", "request": { "name": "Returns one outbound document by its identifier.", "description": {}, "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "259924f6-546d-4720-8c5b-032483bd73a4", "name": "The document, with the UJP answer in its own field.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"status\": 8689,\n \"failureCode\": \"string\",\n \"failureMessage\": \"string\",\n \"createdAt\": \"1963-10-22T00:02:20.814Z\",\n \"partnerEdb\": \"string\",\n \"documentNumber\": \"string\",\n \"amount\": 7462.6063707954545,\n \"currency\": \"string\",\n \"ujp\": {\n \"state\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\",\n \"checkedAt\": \"1972-04-03T17:46:09.995Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c99f1b-f31c-418f-b8d6-96db8dc0481b", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c4394d-ea47-4c4f-a83c-922415a3d4cf", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ffb3d08-068d-4267-a33b-a33a30f90cb6", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "493a316b-7334-4244-af8a-e9d07eeecd0c", "name": "`EARH-3001` — no such document. An unknown identifier and a document belonging to another\r\ntenant give an identical answer.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bef1875-a8fe-49e1-a238-066eb3d7809e", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f25462a3-1d59-4c99-9541-bebb13d43dd3", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier returned when the document was submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d3ab110-2972-4965-a26e-b73673420d61", "name": "Downloads one representation of an outbound document.", "request": { "name": "Downloads one representation of an outbound document.", "description": { "content": "Only what was supplied by the client (`ubl`, and `pdf` if one arrived with the document) or\r\nwhat UJP returned as the final document (`ujp`) is served. A representation that does not\r\nexist for that document is not produced on demand.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "string", "description": "One of `ubl`, `pdf`, `ujp`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "66f78415-bd6d-4c49-ad70-f4409d9069bd", "name": "The stored bytes of the requested representation.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbe3a2fc-abf3-49d1-a07d-51608da0aa6a", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cc1c46b-f46d-4af8-ad03-6e20e9ea913a", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4bddaf8-e61f-4a20-9dfd-8e91a273d39c", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57fdd388-836e-4fdf-a806-8aa8b744e26c", "name": "`EARH-3001` — no such document; `EARH-3002` — the document exists but that representation\r\ndoes not. The two outcomes are told apart by the code.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb10f81-7277-4169-9fa8-481025b8dd3e", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51f0fb5-6189-4935-ac16-65003d2e0f66", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "841dd824-d3e5-4beb-880e-06c420ae758e", "name": "Returns the status history of an outbound document.", "request": { "name": "Returns the status history of an outbound document.", "description": { "content": "Failed attempts are included, not only the successful transitions.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "700db998-9573-4c8a-bf1f-f9f549f65f1e", "name": "The transitions in chronological order.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"transitions\": [\n {\n \"status\": 744,\n \"at\": \"1988-03-16T05:35:42.902Z\",\n \"failureCode\": \"string\"\n },\n {\n \"status\": 3246,\n \"at\": \"1964-02-28T16:37:22.671Z\",\n \"failureCode\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c314dc-74a6-43ff-a578-359ce9c8e0ad", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c629c057-82d7-4299-846d-e5c397f42aea", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2fec2a-492b-4452-94c1-9e9eae961b2f", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8732b89-2a58-4013-8158-d93422c5be5c", "name": "`EARH-3001` — no such document.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26461589-1602-4e26-95e4-de4bd222d43e", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8257240-f9be-4f72-b3af-1e42fda28b51", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bebd9a6d-f212-41c5-875d-a5d83e993052", "name": "Cancels an outbound document.", "request": { "name": "Cancels an outbound document.", "description": { "content": "Cancelling does not delete: the document keeps being returned by its identifier, and the\r\ncancellation itself stays in the history.", "type": "text/plain" }, "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "ed8998dd-2221-4265-83f1-73caeb34d372", "name": "The document is now in status 60 (Cancelled).", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docUid\": \"string\",\n \"status\": 8837\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4ef114-e4d2-4715-b82b-a000c787dc73", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "016d6a26-31f4-4d77-a4ff-03fda7a57316", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a94b5ee-c206-4da8-bee0-dc43e523577a", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87515ce6-03bd-451c-ac66-3a6f5806a395", "name": "`EARH-3001` — no such document.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2d28c4-7e0f-4129-be28-66dbed087d48", "name": "`EARH-3004` — already cancelled; `EARH-3003` — the current status does not allow cancelling.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb8a757-40ee-4748-8064-f608d0969d08", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43a3f17e-9760-4cc8-b859-9aab5cf54997", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "outbound", ":docUid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "docUid", "description": "(Required) Identifier of the document." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d9fdf95c-7085-4c69-ac33-7c07b03f8075", "name": "IntegrationPing", "description": { "content": "Connectivity check for the integration surface.", "type": "text/plain" }, "item": [ { "id": "11c050c7-9ee2-4cf2-894e-8fc49a5b22eb", "name": "Confirms that the service is reachable and that the supplied API key is valid.", "request": { "name": "Confirms that the service is reachable and that the supplied API key is valid.", "description": {}, "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4528dcfc-9aa7-49b9-94bd-a579a52c01b4", "name": "The service is up and the key is valid.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"keyValid\": false,\n \"serverTime\": \"1972-04-24T17:53:21.571Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ac6a03-5523-4bb8-9732-0c5f587f4fd3", "name": "The `X-Software-Id` header is missing — `EARH-1008`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "476bf25b-8fc5-48dc-8502-3910d45e3c91", "name": "The API key is missing, unknown, expired or revoked — `EARH-1001`, `EARH-1002`, `EARH-1003`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb2ff97-6ba9-4746-bec5-aa1c9843f1b0", "name": "The caller's address is outside the allowed list, or the key does not carry the IntegrationApi scope — `EARH-1004`, `EARH-1005`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beba7fa7-bf63-4182-927a-f7a0e4fae5cf", "name": "The traffic limit for this key has been reached — `EARH-1006`. The response carries `Retry-After`.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080d9ae6-ec30-4577-93a2-401eebb95552", "name": "Unexpected error on our side — `EARH-9000`. The body carries `eventId`; quote it when reporting the problem.", "originalRequest": { "url": { "path": [ "api", "integration", "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Identifier of the calling software, e.g. `SSBFocus/4.2.1`. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.", "key": "X-Software-Id", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 3601,\n \"detail\": \"string\",\n \"code\": \"string\",\n \"eventId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Заглавија на ниво на збирка — важат за секој request во неа.", "// Генерирано од scripts/build-postman.mjs; не се уредува рачно.", "pm.request.headers.upsert({ key: \"X-Api-Key\", value: \"{{apiKey}}\" });", "pm.request.headers.upsert({ key: \"X-Software-Id\", value: \"{{softwareId}}\" });" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://sandbox.api.earhiva.mk", "type": "string" }, { "key": "apiKey", "value": "<ВАШИОТ КЛУЧ>", "type": "string" }, { "key": "softwareId", "value": "<ОЗНАКА НА ВАШИОТ СОФТВЕР>", "type": "string" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "55dba8a2-6dac-49a9-8586-42f921ce8478", "name": "eArhiva Integration API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Machine-to-machine surface for external API clients.", "type": "text/plain" } }, "header": [ { "key": "X-Api-Key", "value": "{{apiKey}}" }, { "key": "X-Software-Id", "value": "{{softwareId}}" } ] }