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/c/:company_id/emails",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)
; {
; "current_page": "<integer>",
; "first_page_url": "<uri>",
; "from": "<integer>",
; "last_page": "<integer>",
; "last_page_url": "<uri>",
; "next_page_url": "<uri>",
; "path": "<uri>",
; "per_page": "<integer>",
; "prev_page_url": "<uri>",
; "to": "<integer>",
; "total": "<integer>",
; "data": [
; {
; "id": "<integer>",
; "status": "pending",
; "sent_date": "<dateTime>",
; "errors_count": "<integer>",
; "error_log": "<string>",
; "from_email": "<string>",
; "from_name": "<string>",
; "to_email": "<string>",
; "to_name": "<string>",
; "subject": "<string>",
; "content": "<string>",
; "copy_to": "<string>",
; "recipient_status": "email_opened",
; "recipient_date": "<dateTime>",
; "kind": "<string>",
; "attachments": [
; {
; "filename": "<string>",
; "url": "<string>"
; },
; {
; "filename": "<string>",
; "url": "<string>"
; }
; ]
; },
; {
; "id": "<integer>",
; "status": "sending",
; "sent_date": "<dateTime>",
; "errors_count": "<integer>",
; "error_log": "<string>",
; "from_email": "<string>",
; "from_name": "<string>",
; "to_email": "<string>",
; "to_name": "<string>",
; "subject": "<string>",
; "content": "<string>",
; "copy_to": "<string>",
; "recipient_status": "document_opened",
; "recipient_date": "<dateTime>",
; "kind": "<string>",
; "attachments": [
; {
; "filename": "<string>",
; "url": "<string>"
; },
; {
; "filename": "<string>",
; "url": "<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
status.s
sent_date.s
errors_count.s
error_log.s
from_email.s
from_name.s
to_email.s
to_name.s
subject.s
content.s
copy_to.s
recipient_status.s
recipient_date.s
kind.s
j.i
count_j.i
filename.s
url.s
current_page.s = CkJsonObject::ckStringOf(jResp,"current_page")
first_page_url.s = CkJsonObject::ckStringOf(jResp,"first_page_url")
from.s = CkJsonObject::ckStringOf(jResp,"from")
last_page.s = CkJsonObject::ckStringOf(jResp,"last_page")
last_page_url.s = CkJsonObject::ckStringOf(jResp,"last_page_url")
next_page_url.s = CkJsonObject::ckStringOf(jResp,"next_page_url")
path.s = CkJsonObject::ckStringOf(jResp,"path")
per_page.s = CkJsonObject::ckStringOf(jResp,"per_page")
prev_page_url.s = CkJsonObject::ckStringOf(jResp,"prev_page_url")
v_to.s = CkJsonObject::ckStringOf(jResp,"to")
total.s = CkJsonObject::ckStringOf(jResp,"total")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
status = CkJsonObject::ckStringOf(jResp,"data[i].status")
sent_date = CkJsonObject::ckStringOf(jResp,"data[i].sent_date")
errors_count = CkJsonObject::ckStringOf(jResp,"data[i].errors_count")
error_log = CkJsonObject::ckStringOf(jResp,"data[i].error_log")
from_email = CkJsonObject::ckStringOf(jResp,"data[i].from_email")
from_name = CkJsonObject::ckStringOf(jResp,"data[i].from_name")
to_email = CkJsonObject::ckStringOf(jResp,"data[i].to_email")
to_name = CkJsonObject::ckStringOf(jResp,"data[i].to_name")
subject = CkJsonObject::ckStringOf(jResp,"data[i].subject")
content = CkJsonObject::ckStringOf(jResp,"data[i].content")
copy_to = CkJsonObject::ckStringOf(jResp,"data[i].copy_to")
recipient_status = CkJsonObject::ckStringOf(jResp,"data[i].recipient_status")
recipient_date = CkJsonObject::ckStringOf(jResp,"data[i].recipient_date")
kind = CkJsonObject::ckStringOf(jResp,"data[i].kind")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attachments")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
filename = CkJsonObject::ckStringOf(jResp,"data[i].attachments[j].filename")
url = CkJsonObject::ckStringOf(jResp,"data[i].attachments[j].url")
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/c/:company_id/emails
Postman Collection Item JSON
{
"name": "List emails",
"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}}/c/:company_id/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "List Emails."
},
"response": [
{
"name": "Example response",
"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}}/c/:company_id/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"status\": \"pending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"email_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n {\n \"id\": \"<integer>\",\n \"status\": \"sending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"document_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n}"
}
]
}
