Create and Manage Custom APIs | Zoho Creator Help

Create and Manage Custom APIs

This help page is for users in Creator 6. Find your  Creator version.

1. What Does This Page Cover?

Learn how to create a custom API and authenticate it to integrate with in Zoho Creator.

Before moving ahead, click here to learn more about custom APIs.

2. Availability

Custom APIs:
  1. Can be created and managed in all pricing plans of Creator. However, the number of times a custom API can be invoked is limited in the free plans
  2. Can only be created, authorized, and managed by the  super admin and admins , while other  users  can access them
  3. Are available in all data centers

3. Creating custom APIs

3.1 Custom API Creation Flow


3.2 See How To Configure


3.3 Steps to Create and Manage a Custom API

  1. Create a Custom API
  2. View Custom API details
  3. Manage Custom API
  4. Delete and Disable Custom API
  5. Call a custom API

Create a Custom API

You cannot test your custom APIs in development environment since only the Deluge functions available in production environment can be exposed as a custom API. 
1. Navigate to the Microservices page in your Creator account.
2. Click the + Create New button at the top-right corner.
You can also select the Custom API tab and click + Create Custom API if you're creating a custom API for the first time. The Custom API builder will appear, which can only be accessed by the super admin and admins.

3. Click Create in the Custom API card. The Custom API builder will appear.    


Step 1: Specify basic inputs to define your custom API


1. In the Basic Inputs tab, enter a display name for your custom API. This name will be displayed in the respective card listed in the Microservices section.
It is essential to choose names for your custom APIs that are descriptive, memorable, and reflective of their functionality. 
2. Enter a suitable link name based on the entered display name. For example, if the name of your custom API is CreateApp API, the relevant link name would be create_app_api.
The link name of your custom API cannot contain special characters such as  !@#$%^&*.>
3. Describe the purpose of your custom API in no more than 200 words.
4. Click Next.

Step 2: Provide essential request details

In the Request tab, you can specify the method, authentication, user scope,  and content type used in the body of the custom API request.

1. Choose the method type, GET, POST, PUT or DELETE, depending on the type of action you want to perform. 
Refer to this section to know about the API scopes for different methods.

2. Select the Authentication type: OAuth2 or Public Key. By default, OAuth2 will be selected. 
3. Define the scope of your custom API as either Admin Only or Selective Users. This lets you set the level of access for admins and different user roles. 
  1. If you choose Admin Only, the API will work on Admin's scope. 

  2. If you choose Specific users, the API will only be accessible by the specified users i.e., you can specify the email addresses of the respective users.

5. Select the Content Type as either application/json or multipart/form-data. This is used to specify how the request payload should be interpreted by the server.

6. Select the Argument Type as either Key and Value or Entire JSON. Learn More
When you choose the argument type as entire JSON for your custom API, ensure that you specify only one argument of string datatype.
7. Click Next.

Step 3: Provide format type for response

In the Response tab, you can choose a relevant response type and specify appropriate error codes.
Custom response lets you specify the status code and respective response codes.
1. Choose a corresponding response type: Standard or Custom.
  1. If you've chosen the Standard response type, the response will return status codes currently followed by Creator's REST APIs.

  2. If you've chosen the Custom option, the Add Custom Response slider opens below.
    1. Enter a suitable Status Code. For example, you can enter status codes like 200, 202, 401, and so on.
    2. Enter corresponding Response Codes for the status codes you've entered. For example, the response codes could be 2002, 3400, 4434, and so on.

2. Click the + icon beside the added code to add more status codes and respective response codes.
3. Click the delete icon to delete the a status code and its respective response codes.
4. Click Next.

Step 4: Specify the details of function execution

In the Actions tab, specify the details of the function to be executed when called.

1. Choose the required application from the Application dropdown.
2. Select the respective Name Space that groups the function you want to be called.
Note: If no namespace is specified for your created function, then that function will be added to the Default namespace. 
3. Select the required Deluge function that needs to be executed when called from the dropdown.

Step 5: Preview and create custom API

In the Summary tab, you can review your custom API details before completing its creation.
The below image shows Summary tab for standard response.

The below image shows Summary tab for custom response.

  1. Copy the Endpoint URL as required from the URL preview card.
  2. Check the details displayed in the Overview, Request Body, and Response Body tabs.
  3. Click Back to make changes to previous tabs. Your custom API will be saved as a draft.
  4. Click Save after reviewing the changes. Your custom API will be created successfully and you'll be taken to the Detail View page of the created custom API.
  1. If you close the Custom API builder unknowingly, your changes will be saved as draft and you can continue editing them anytime from Microservices > Custom API > required custom API card.
  2. URL preview will be generated based on the specified link name in the following format. This URL lets you and your users access and execute the associated function. You can copy and use the URL as required.
    www.zohoapis.com/creator/custom/AdminName/CustomAPIName

View Custom API details

Below is the Detail View page of the custom API you've created in which you can view the following details.


Only super admin and admins can view API hits i.e., users cannot view API hits.

To access this page,
  1. Navigate to the Microservices page in your Creator account.
  2. Click the Custom API tab at the top-right corner.
  3. Click the required custom API card. The Detail View page will appear.

You can view the essential details of the custom API, the application in which it is used, and its installation and updation details. You can also view the API hits filtered by the users who invoked the API, log date and time, status code, and status of the API (success or failure). Additionally, you can also view the following.
  1. Click the dropdown arrow beside Last 60 days to view the API logs at different time periods. The API logs will display the logs of last 30 days by default.

  2. Click the Filter icon to view the API hits based on either Status Codes or API Status (success or failure), then click Apply.
    1. If you've chosen the Status Code, enter the required value and click Apply.
    2. If you've chosen the API Status, choose either Success or Failure and view the respective logs.

You can also click the Failure status to view additional error details. 
  1. Click the Prev or Next buttons at the bottom the page to view more logs of API hits.
  2. Click the ellipsis icon (triple dots) at the top-right to edit, delete or disable the custom API.

Manage Users

  1. Navigate to the Microservices page in your Creator account.
  2. Click the Custom API tab at the top-right corner.
  3. Select the required custom API card.
  4. Click (n) Users  beside User Scope to add more users if you've selected the Selective Users option in the User scope.
  5. Add the email addresses of admins and users in the Manage Users popup that appears.

  6. Click Save.
Note: You cannot edit the User Scope inside the API Detail View page.

Edit custom API

  1. Navigate to the Microservices page in your Creator account.
  2. Click the Custom API tab at the top-right corner.
  3. Click the ellipsis icon (triple dots) in the required custom API card.
  4. Click Edit API to edit your custom API. The Custom API builder will appear.

  5. Make the required changes in the respective sections and click Save after previewing the changes.

Filter based on custom API state

  1. Navigate to the Microservices page in your Creator account.
  2. Click the Custom API tab at the top-right corner.
  3. Click the filter icon at the right corner of the Custom API tab.

  4. Select the status - enabled, disabled or draft to view the custom APIs created in the respective stages.

Delete and Disable Custom API

1. Navigate to the Microservices page in your Creator account.
2. Click the Custom API tab at the top-right corner.
3. Click the ellipsis icon (triple dots) in the required custom API card.
4. Select the Disable option to disable the custom API. 

When you invoke a disabled API, an empty response will be returned. Invoking a disabled API will produce a record in API logs, but will not be registered as an API hit. 
5. Click Disable in the Disable Custom API popup that appears. The respective API will be disabled in the Microservices section. 


You can click Enable to enable it.

6. Click Delete to delete the required custom API. 

Note: When a custom API is deleted, it is removed from Microservices but the function associated with that custom API is retained in it's respective Creator application.
  1. Before you can delete a function used in your Custom API, you will have to remove the associated Custom API before deleting the respective function.
  2. When you update a function that is currently being used in any of your custom APIs, you will be notified that the API will be configured to the latest version of the updated function.

5. Calling A Custom API

Before invoking a custom API, you need to perform the steps mentioned under each of the below headings. To invoke the custom API you've created, you can use the endpoint URL copied from the the detailed view of your Custom API in the external service from which you to perform the defined actions.
  1. Register the client application
  2. Request the authorization code
  3. Generate the access and refresh tokens
  4. Refresh the access token
  5. Revoke the refresh token
  1. If you've chosen the authentication type as OAuth2, the specified users or admins will be authenticated and they can directly invoke the endpoint URL in any external platform.
  2. If you've chosen the authentication type as Public Key, the public key will be displayed in the API Detail View page. Any user in your Creator application can invoke the custom API using this public key.

6. Points to Note

  1. The link name of your custom API cannot contain special characters such as  !@#$%^&*.>.
  2. The status codes in custom response can range from 100 to 599.
  3. The response codes in custom response must be in the range from 1 to 9999 and cannot contain special characters such as  !@#$%^&*.>.
  4. When you change the user scope of your custom API to Admins Only from Selective Users, all the users you've previously added will be removed. 
  5. If you close the Custom API builder without saving, your changes will still be saved as a draft and you can continue editing them anytime from Microservices > Custom API > required custom API card.
  6. When you invoke a disabled API, an empty response will be returned i.e., invoking a disabled API will produce a record in API logs but will not be registered as an API hit. 
  7. Before you can delete a function used in your Custom API, you will have to remove the associated Custom API before deleting the respective function.

7. Limitations

  1. In the Response tab, you can add upto 50 status codes.
  2. Your custom response codes can contain only upto 4 digits.
  1. Understand custom APIs
  2. Rest APIs in Creator



    Zoho CRM Training Programs

    Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

    Zoho CRM Training
      Redefine the way you work
      with Zoho Workplace

        Zoho DataPrep Personalized Demo

        If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

        Zoho CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                    You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              Zoho Sheet Resources

                                               

                                                  Zoho Forms Resources


                                                    Secure your business
                                                    communication with Zoho Mail


                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times


                                                      Carry your calendar with you
                                                      Anytime, anywhere




                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now




                                                                      Zoho TeamInbox Resources



                                                                              Zoho DataPrep Resources



                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW


                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now









                                                                                                      • Related Articles

                                                                                                      • Understand Custom APIs

                                                                                                        This help page is for users in Creator 6. Find your Creator version. 1. What Does This Page Cover? Learn about custom APIs and how to define their actions using Deluge functions, which can then be exposed as an API and called from an external ...
                                                                                                      • Create and Manage Permissions

                                                                                                        What Does This Page Cover? Learn to create permission sets that determine the actions a user can perform when they have access to the data of an application. Availability Permissions is accessible in all plans of Creator. Addition of new permission ...
                                                                                                      • Create Custom Connector

                                                                                                        Note: This feature is only available in C6. Custom Connectors are created to integrate with services that are not available as Zoho Creator's built-in connectors. You can configure your own connector for the desired service and create a connection. ...
                                                                                                      • Display custom action button for specific records

                                                                                                        Requirement   The custom action button in a report should be visible only for certain records, based on a condition. Use Case   An asset request app lets employees raise requests for gadgets or machines. While filling the form, employees can specify ...
                                                                                                      • Manage Custom Connectors

                                                                                                        Note: Custom connectors are only available in C6. Manage Custom Connectors 1. Navigate to the Microservices tab and scroll down to the Connections section. 2. If you have three or less connections, click Manage Custom Connectors that appears across ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace

                                                                                                          Resources

                                                                                                          Videos

                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                          eBooks

                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                          Webinars

                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.



                                                                                                            Zoho Show Resources