Chilkat Online Tools

Ruby / KSeF / Nadanie poświadczeń

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "grantCredentials": {
#     "credentialsIdentifier": {
#       "type": "<string>",
#       "identifier": "<string>"
#     },
#     "credentialsRoleList": [
#       {
#         "roleDescription": "<string>",
#         "roleType": "tax_representative"
#       }
#     ]
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("grantCredentials.credentialsIdentifier.type","<string>")
json.UpdateString("grantCredentials.credentialsIdentifier.identifier","<string>")
json.UpdateString("grantCredentials.credentialsRoleList[0].roleDescription","<string>")
json.UpdateString("grantCredentials.credentialsRoleList[0].roleType","tax_representative")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("SessionToken","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://ksef.mf.gov.pl/api/online/Credentials/Grant","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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 POST
	-H "SessionToken: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "grantCredentials": {
    "credentialsIdentifier": {
      "type": "<string>",
      "identifier": "<string>"
    },
    "credentialsRoleList": [
      {
        "roleDescription": "<string>",
        "roleType": "tax_representative"
      }
    ]
  }
}'
https://ksef.mf.gov.pl/api/online/Credentials/Grant

Postman Collection Item JSON

{
  "name": "Nadanie 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": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"grantCredentials\": {\n    \"credentialsIdentifier\": {\n      \"type\": \"<string>\",\n      \"identifier\": \"<string>\"\n    },\n    \"credentialsRoleList\": [\n      {\n        \"roleDescription\": \"<string>\",\n        \"roleType\": \"tax_representative\"\n      }\n    ]\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/online/Credentials/Grant",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "online",
        "Credentials",
        "Grant"
      ]
    },
    "description": "Nadanie poświadczeń"
  },
  "response": [
    {
      "name": "Dane zostały zapisane",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"grantCredentials\": {\n    \"credentialsIdentifier\": {\n      \"type\": \"<string>\",\n      \"identifier\": \"<string>\"\n    },\n    \"credentialsRoleList\": [\n      {\n        \"roleDescription\": \"<string>\",\n        \"roleType\": \"tax_representative\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Grant",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Grant"
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_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": "Nie znaleziono danych",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"grantCredentials\": {\n    \"credentialsIdentifier\": {\n      \"type\": \"<string>\",\n      \"identifier\": \"<string>\"\n    },\n    \"credentialsRoleList\": [\n      {\n        \"roleDescription\": \"<string>\",\n        \"roleType\": \"tax_representative\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Grant",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Grant"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"grantCredentials\": {\n    \"credentialsIdentifier\": {\n      \"type\": \"<string>\",\n      \"identifier\": \"<string>\"\n    },\n    \"credentialsRoleList\": [\n      {\n        \"roleDescription\": \"<string>\",\n        \"roleType\": \"tax_representative\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Grant",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Grant"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"grantCredentials\": {\n    \"credentialsIdentifier\": {\n      \"type\": \"<string>\",\n      \"identifier\": \"<string>\"\n    },\n    \"credentialsRoleList\": [\n      {\n        \"roleDescription\": \"<string>\",\n        \"roleType\": \"tax_representative\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/online/Credentials/Grant",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Credentials",
            "Grant"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}