Chilkat Online Tools

phpAx / KSeF / Sprawdzenie statusu poświadczeń

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new COM("Chilkat_9_5_0.Http");

$http->SetRequestHeader('Accept','application/json');
$http->SetRequestHeader('SessionToken','{{apiKey}}');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://ksef.mf.gov.pl/api/online/Credentials/Status/:CredentialsElementReferenceNumber',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "elementReferenceNumber": "20381227-A3-CA298ACF1B-A77572ED44-1B",
//   "processingCode": "<integer>",
//   "processingDescription": "<string>",
//   "referenceNumber": "30480625-8U-8A27E3D99A-9CF5526372-2A",
//   "timestamp": "<dateTime>"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$elementReferenceNumber = $jResp->stringOf('elementReferenceNumber');
$processingCode = $jResp->stringOf('processingCode');
$processingDescription = $jResp->stringOf('processingDescription');
$referenceNumber = $jResp->stringOf('referenceNumber');
$timestamp = $jResp->stringOf('timestamp');

?>

Curl Command

curl -X GET
	-H "SessionToken: {{apiKey}}"
	-H "Accept: application/json"
https://ksef.mf.gov.pl/api/online/Credentials/Status/:CredentialsElementReferenceNumber

Postman Collection Item JSON

{
  "name": "Sprawdzenie statusu poświadczeń",
  "request": {
    "auth": {
      "type": "apikey",
      "apikey": [
        {
          "key": "key",
          "value": "SessionToken",
          "type": "string"
        },
        {
          "key": "value",
          "value": "{{apiKey}}",
          "type": "string"
        },
        {
          "key": "in",
          "value": "header",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/online/Credentials/Status/:CredentialsElementReferenceNumber",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "online",
        "Credentials",
        "Status",
        ":CredentialsElementReferenceNumber"
      ],
      "variable": [
        {
          "key": "CredentialsElementReferenceNumber",
          "value": "56810128-EL-96284D87EE-8DDB16145F-B3"
        }
      ]
    },
    "description": "Sprawdzenie statusu poświadczeń"
  },
  "response": [
    {
      "name": "Poświadczenie wykonane prawidłowo",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Status/:CredentialsElementReferenceNumber",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Status",
            ":CredentialsElementReferenceNumber"
          ],
          "variable": [
            {
              "key": "CredentialsElementReferenceNumber"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"elementReferenceNumber\": \"20381227-A3-CA298ACF1B-A77572ED44-1B\",\n  \"processingCode\": \"<integer>\",\n  \"processingDescription\": \"<string>\",\n  \"referenceNumber\": \"30480625-8U-8A27E3D99A-9CF5526372-2A\",\n  \"timestamp\": \"<dateTime>\"\n}"
    },
    {
      "name": "Nieprawidłowe wywołanie",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Status/:CredentialsElementReferenceNumber",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Status",
            ":CredentialsElementReferenceNumber"
          ],
          "variable": [
            {
              "key": "CredentialsElementReferenceNumber"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    },
    {
      "name": "Nieautoryzowany dostęp",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Status/:CredentialsElementReferenceNumber",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Status",
            ":CredentialsElementReferenceNumber"
          ],
          "variable": [
            {
              "key": "CredentialsElementReferenceNumber"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    },
    {
      "name": "Nie znaleziono wyszukiwanej treści",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Status/:CredentialsElementReferenceNumber",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Status",
            ":CredentialsElementReferenceNumber"
          ],
          "variable": [
            {
              "key": "CredentialsElementReferenceNumber"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}