Each partner has client business accounts and an online presence. Each environment is known as a "Directory", and all the client's associated business accounts use the directory configuration. i.e. Branding, partner domain, Partner's external pages in account management etc.

A partner can have several directories for different purposes: Production, Sandbox, Demo etc.
Each directory also has its own authorization token to use for API requests.

🚧

Note

Directory tokens are unique for each directory and can only be used for requests relevant to accounts and apps in this specific directory.

Your API Token

As an inTandem partner, you'll need to use a unique token provided to partners and directory admins.

In order to receive your unique token, please contact us at [email protected] or contact your account manager.

📘

Directory token

The directory token can be used for APIs dedicated to partners and directory owners, like the Create Business API, or to send API requests on behalf of a specific business that is nested under the directory.

📘

x-on-behalf-of

The x-on-behalf-of header lets you send API requests on behalf of specific businesses using the directory token.

Example of an API request for getting business clients:

GET https://api.vcita.biz/platform/v1/clients

headers: {"Authorization": "Bearer YOUR_DIRECTORY_TOKEN"}

curl --location --request GET 'https://api.vcita.biz/platform/v1/clients' \
--header 'x-on-behalf-of: {BUSINESS_ID}' \
--header 'Authorization: Bearer {DIRECTORY_TOKEN}' \

Example of API Response

{
    "status": "OK",
    "data": {
        "clients": [
            {
                "id": "6vc9t1hthvlvz34f",
                "first_name": "My",
                "last_name": "Name",
                "mobile_phone": null,
                "email": "[email protected]",
                "address": null,
                "created_at": "2021-08-12T13:03:47Z",
                "updated_at": "2021-10-13T09:37:37Z",
                "customer_status": "lead",
                "tags": [],
                "opt_in": null,
                "source": "Facebook",
                "source_url": null,
                "channel": null,
                "campaign": null,
                "business_uid": "ua123a14yoqqz3r3"
            }
         [
     }
}