Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api-v2.fattureincloud.it/user/companies",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "companies": [
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "accountant",
; "access_token": "<string>",
; "controlled_companies": [
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "accountant",
; "access_token": "<string>",
; "connection_id": "<number>",
; "tax_code": "<string>"
; },
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "accountant",
; "access_token": "<string>",
; "connection_id": "<number>",
; "tax_code": "<string>"
; }
; ],
; "connection_id": "<integer>",
; "tax_code": "<string>"
; },
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "company",
; "access_token": "<string>",
; "controlled_companies": [
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "accountant",
; "access_token": "<string>",
; "connection_id": "<number>",
; "tax_code": "<string>"
; },
; {
; "id": "<integer>",
; "name": "<string>",
; "type": "company",
; "access_token": "<string>",
; "connection_id": "<number>",
; "tax_code": "<string>"
; }
; ],
; "connection_id": "<integer>",
; "tax_code": "<string>"
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
name.s
v_type.s
access_token.s
connection_id.s
tax_code.s
j.i
count_j.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.companies")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.companies[i].id")
name = CkJsonObject::ckStringOf(jResp,"data.companies[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"data.companies[i].type")
access_token = CkJsonObject::ckStringOf(jResp,"data.companies[i].access_token")
connection_id = CkJsonObject::ckStringOf(jResp,"data.companies[i].connection_id")
tax_code = CkJsonObject::ckStringOf(jResp,"data.companies[i].tax_code")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data.companies[i].controlled_companies")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
id = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].id")
name = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].name")
v_type = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].type")
access_token = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].access_token")
connection_id = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].connection_id")
tax_code = CkJsonObject::ckStringOf(jResp,"data.companies[i].controlled_companies[j].tax_code")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/user/companies
Postman Collection Item JSON
{
"name": "List User Companies",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/user/companies",
"host": [
"{{baseUrl}}"
],
"path": [
"user",
"companies"
]
},
"description": "Lists the companies controlled by the current user."
},
"response": [
{
"name": "User Companies.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/user/companies",
"host": [
"{{baseUrl}}"
],
"path": [
"user",
"companies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"companies\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"accountant\",\n \"access_token\": \"<string>\",\n \"controlled_companies\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"accountant\",\n \"access_token\": \"<string>\",\n \"connection_id\": \"<number>\",\n \"tax_code\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"accountant\",\n \"access_token\": \"<string>\",\n \"connection_id\": \"<number>\",\n \"tax_code\": \"<string>\"\n }\n ],\n \"connection_id\": \"<integer>\",\n \"tax_code\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"access_token\": \"<string>\",\n \"controlled_companies\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"accountant\",\n \"access_token\": \"<string>\",\n \"connection_id\": \"<number>\",\n \"tax_code\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"access_token\": \"<string>\",\n \"connection_id\": \"<number>\",\n \"tax_code\": \"<string>\"\n }\n ],\n \"connection_id\": \"<integer>\",\n \"tax_code\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/user/companies",
"host": [
"{{baseUrl}}"
],
"path": [
"user",
"companies"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
