phpExt / KSeF / Sprawdzenie statusu sesji ogólnej
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateInt('PageSize',10);
$queryParams->UpdateInt('PageOffset',0);
$queryParams->UpdateString('IncludeDetails','true');
$http->SetRequestHeader('Accept','application/json');
$http->SetRequestHeader('SessionToken','{{apiKey}}');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://ksef.mf.gov.pl/api/online/Session/Status/:ReferenceNumber',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "creationTimestamp": "<dateTime>",
// "entityType": "<string>",
// "lastUpdateTimestamp": "<dateTime>",
// "processingCode": "<integer>",
// "processingDescription": "<string>",
// "referenceNumber": "27171215-HY-2C82107214-1D5F90FA88-2E",
// "timestamp": "<dateTime>",
// "invoiceStatusList": [
// {
// "elementReferenceNumber": "67730731-BT-BB0B759DA9-D861FFD666-F7",
// "processingCode": "<integer>",
// "processingDescription": "<string>",
// "acquisitionTimestamp": "<dateTime>",
// "invoiceNumber": "<string>",
// "ksefReferenceNumber": "M589364889-24840303-BAD08EE6BCE5-9D"
// },
// {
// "elementReferenceNumber": "23341031-IK-42BD8BA85B-E2BAE0244C-4F",
// "processingCode": "<integer>",
// "processingDescription": "<string>",
// "acquisitionTimestamp": "<dateTime>",
// "invoiceNumber": "<string>",
// "ksefReferenceNumber": "UUX0645446-28171227-5D321BCCA530-F1"
// }
// ],
// "numberOfElements": "<long>",
// "pageOffset": "<integer>",
// "pageSize": "<integer>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$creationTimestamp = $jResp->stringOf('creationTimestamp');
$entityType = $jResp->stringOf('entityType');
$lastUpdateTimestamp = $jResp->stringOf('lastUpdateTimestamp');
$processingCode = $jResp->stringOf('processingCode');
$processingDescription = $jResp->stringOf('processingDescription');
$referenceNumber = $jResp->stringOf('referenceNumber');
$timestamp = $jResp->stringOf('timestamp');
$numberOfElements = $jResp->stringOf('numberOfElements');
$pageOffset = $jResp->stringOf('pageOffset');
$pageSize = $jResp->stringOf('pageSize');
$i = 0;
$count_i = $jResp->SizeOfArray('invoiceStatusList');
while ($i < $count_i) {
$jResp->put_I($i);
$elementReferenceNumber = $jResp->stringOf('invoiceStatusList[i].elementReferenceNumber');
$processingCode = $jResp->stringOf('invoiceStatusList[i].processingCode');
$processingDescription = $jResp->stringOf('invoiceStatusList[i].processingDescription');
$acquisitionTimestamp = $jResp->stringOf('invoiceStatusList[i].acquisitionTimestamp');
$invoiceNumber = $jResp->stringOf('invoiceStatusList[i].invoiceNumber');
$ksefReferenceNumber = $jResp->stringOf('invoiceStatusList[i].ksefReferenceNumber');
$i = $i + 1;
}
?>
Curl Command
curl -G -d "PageSize=10"
-d "PageOffset=0"
-d "IncludeDetails=true"
-H "SessionToken: {{apiKey}}"
-H "Accept: application/json"
https://ksef.mf.gov.pl/api/online/Session/Status/:ReferenceNumber
Postman Collection Item JSON
{
"name": "Sprawdzenie statusu sesji ogólnej",
"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/Session/Status/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
"host": [
"{{baseUrl}}"
],
"path": [
"online",
"Session",
"Status",
":ReferenceNumber"
],
"query": [
{
"key": "PageSize",
"value": "10"
},
{
"key": "PageOffset",
"value": "0"
},
{
"key": "IncludeDetails",
"value": "true"
}
],
"variable": [
{
"key": "ReferenceNumber",
"value": "56810128-EL-96284D87EE-8DDB16145F-B3"
}
]
},
"description": "Sprawdzenie statusu przetwarzania na podstawie numeru referencyjnego"
},
"response": [
{
"name": "Sprawdzanie statusu sesji zakończone poprawnie",
"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/Session/Status/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
"host": [
"{{baseUrl}}"
],
"path": [
"online",
"Session",
"Status",
":ReferenceNumber"
],
"query": [
{
"key": "PageSize",
"value": "10"
},
{
"key": "PageOffset",
"value": "0"
},
{
"key": "IncludeDetails",
"value": "true"
}
],
"variable": [
{
"key": "ReferenceNumber"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"creationTimestamp\": \"<dateTime>\",\n \"entityType\": \"<string>\",\n \"lastUpdateTimestamp\": \"<dateTime>\",\n \"processingCode\": \"<integer>\",\n \"processingDescription\": \"<string>\",\n \"referenceNumber\": \"27171215-HY-2C82107214-1D5F90FA88-2E\",\n \"timestamp\": \"<dateTime>\",\n \"invoiceStatusList\": [\n {\n \"elementReferenceNumber\": \"67730731-BT-BB0B759DA9-D861FFD666-F7\",\n \"processingCode\": \"<integer>\",\n \"processingDescription\": \"<string>\",\n \"acquisitionTimestamp\": \"<dateTime>\",\n \"invoiceNumber\": \"<string>\",\n \"ksefReferenceNumber\": \"M589364889-24840303-BAD08EE6BCE5-9D\"\n },\n {\n \"elementReferenceNumber\": \"23341031-IK-42BD8BA85B-E2BAE0244C-4F\",\n \"processingCode\": \"<integer>\",\n \"processingDescription\": \"<string>\",\n \"acquisitionTimestamp\": \"<dateTime>\",\n \"invoiceNumber\": \"<string>\",\n \"ksefReferenceNumber\": \"UUX0645446-28171227-5D321BCCA530-F1\"\n }\n ],\n \"numberOfElements\": \"<long>\",\n \"pageOffset\": \"<integer>\",\n \"pageSize\": \"<integer>\"\n}"
},
{
"name": "Nie znaleziono danych",
"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/Session/Status/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
"host": [
"{{baseUrl}}"
],
"path": [
"online",
"Session",
"Status",
":ReferenceNumber"
],
"query": [
{
"key": "PageSize",
"value": "10"
},
{
"key": "PageOffset",
"value": "0"
},
{
"key": "IncludeDetails",
"value": "true"
}
],
"variable": [
{
"key": "ReferenceNumber"
}
]
}
},
"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/Session/Status/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
"host": [
"{{baseUrl}}"
],
"path": [
"online",
"Session",
"Status",
":ReferenceNumber"
],
"query": [
{
"key": "PageSize",
"value": "10"
},
{
"key": "PageOffset",
"value": "0"
},
{
"key": "IncludeDetails",
"value": "true"
}
],
"variable": [
{
"key": "ReferenceNumber"
}
]
}
},
"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}"
}
]
}
