Getting started

Zoho Apptics APIs requires these two mandatory fields in the header.

  1. Project identification details:

    1. ZAK: An authentication key that is used to verify the respective application. You can access this from QuickStart > Settings icon > Download config file. You can find the ZAK key in the config file.
    2. Combination of zsoid and projectid. You can fetch these two values from the URL of the page.
      Sample URL - https://apptics.zoho.com/ac/766556673/dashboard/782000000004007/1/2?platform=
      In the URL mentioned, 766556673 is the zsoid and 782000000004007 is the projectid.

    Either (1) or (2) is necessary for the APIs to work. If both are given, (1) will be considered. 

  2. Authorization - Bearer token (refer to OAuth 2.0)

HTTP Methods

Zoho Apptics APIs enable data manipulation and retrieval through different HTTP methods.

MethodPurpose
GETRetrieve sources
POSTCreate resources and perform resource actions
PUTUpdate resources
DELETE  Delete resources

Errors

Zoho Apptics uses HTTP status codes to indicate success or failure of API calls. Status codes in the 2xx range indicate success, 4xx range indicate the error in the information provided and 5xx range indicate the server-side errors. Below is the list of some of the commonly used HTTP status codes.

Status CodeDescription
200Ok
201Created
204No Content
400Bad Request
401Unauthorized
403Forbidden (unauthorized access)
404URL not found
405Method not allowed (Method called is not supported for the invoked API)   
413Payload too large
415Unsupported media type
422Unprocessable entity
429Too many requests
500Internal error