Multi-Org and Multi-DC Support

Catalyst is currently hosted in four data centers. The base API URI to access all Catalyst APIs and the Zoho Accounts Server URI will be different based on the data center you are accessing Catalyst from.

You must use the appropriate domain based on your location while sending an API request in Catalyst. This prevents conflicts with your browser and enables a smooth integration with your current session.

The four data centers and their respective base API URIs supported by Catalyst for all APIs are:

  • US:https://api.catalyst.zoho.com
  • EU:https://api.catalyst.zoho.eu
  • IN:https://api.catalyst.zoho.in
  • AU: https://api.catalyst.zoho.au

The corresponding Zoho Accounts Server URI for the four data centers that you must use while implementing OAuth 2.0 authentication are:

  • US:https://accounts.zoho.com
  • EU:https://accounts.zoho.eu
  • IN:https://accounts.zoho.in
  • AU: https://accounts.zoho.au

You must ensure you perform the following actions to make use of Catalyst's multi-DC support:

  • You must use the appropriate Zoho Accounts Server URI in all the steps while implementing OAuth 2.0 authentication, such as while making an authorization request to generate the grant token, access token, or refresh token.

    For example, you can make this request to generate the grant token using a redirect method for the EU data center:
     
    https://accounts.zoho.eu/oauth/v2/auth?scope=ZohoCatalyst.tables.rows.CREATE,ZohoCatalyst.tables.rows.READ,ZohoCatalyst.tables.rows.UPDATE,ZohoCatalyst.tables.rows.DELETE&client_id=1000.0SRSxxxxxxxxxxxxxxxxxxxxx&state=testing&response_type=code&redirect_uri=https://www.zylker.eu/ShipmentTracking/&access_type=offline

    A response with the grant token will be returned after redirecting to the redirect URI, which will contain a location parameter as shown below:


    This location parameter specifies the domain of your account. In this case, the location is returned as eu.
  • You can enable multi-DC support after you register your client in Zoho's API console. This lets you provide access to your application to users of a specific domain alone. For example, you can disable access to your application for the IN users and enable it for the other users. Refer to Register a New Client section for details.
  • As mentioned earlier, you must use the appropriate base API URI while sending an API request. For example, to fetch all rowss in a table in your Data Store, you must execute the following request URL for the EU data center:
    https://api.catalyst.zoho.eu/baas/v1/project/{project_id}/table/{tableIdentifier}/row

Multi-Org Support

Catalyst allows you to create and manage multiple organizations within your Catalyst account. A unique Org ID will be generated for every organization you create. You can create indivudual projects in each organization and also assign access permissions to people contributing to the project.

You can only have one organization in your account as the default one. The organization marked as default will be logged in automatically when you sign in to your Catalyst account every time.

While you execute an API from Catalyst, it will be executed for the default organization automatically. For instance, when you pass the project ID in your API request, Catalyst will automatically look for a project with the same ID in your default organization. However, you can execute an API for other organizations that are not the default by exclusively passing the unique Org ID of those organizations in your requests.

You can pass the Org ID as a header in an API request to access a project in that organization in this format:

-H 'CATALYST-ORG: 15090237'

You can check a complete sample request from the Request Format section