Chilkat Online Tools

DataFlex / Broker API / All Accounts

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    String sTemp1
    Integer iTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Set ComBasicAuth Of hoHttp To True
    Set ComLogin Of hoHttp To "{{api_key}}"
    Set ComPassword Of hoHttp To "{{api_secret}}"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://domain.com/v1/accounts" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLastStatus Of hoHttp To iTemp1
    Showln "Response status code = " iTemp1
    Get ComGetAsString Of hoSbResponseBody To sTemp1
    Showln sTemp1


End_Procedure

Curl Command

curl -X GET
	-u '{{api_key}}:{{api_secret}}'
https://domain.com/v1/accounts

Postman Collection Item JSON

{
  "name": "All Accounts",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{HOST}}/v1/accounts",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "accounts"
      ],
      "query": [
        {
          "key": "query",
          "value": "John Doe",
          "description": "Pass space-delimited tokens. The response will contain accounts that match with each of the tokens (logical AND). A match means the token is present in either the account’s associated account number, phone number, name, or e-mail address (logical OR).",
          "disabled": true
        },
        {
          "key": "created_after",
          "value": "2021-09-09T0:00:00Z",
          "disabled": true
        },
        {
          "key": "created_before",
          "value": "2021-09-09T0:00:00Z",
          "disabled": true
        },
        {
          "key": "status",
          "value": "ACTIVE",
          "description": "ENUM.AccountStatus",
          "disabled": true
        },
        {
          "key": "sort",
          "value": "asc",
          "description": "asc or desc. Defaults to desc",
          "disabled": true
        },
        {
          "key": "entities",
          "value": null,
          "description": "Comma-delimited entity names to include in the response",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}