Connectors are used as an authentication mechanism when integrating third-party applications with Zoho Mail. These connectors can be used to create extensions for the eWidget. These extensions are built to invoke the REST APIs of the third-party applications. In order to do that, Zoho Mail needs to be authorized to access the APIs and data from the external application.
You can create connectors in Zoho Mail to undertake this authorization process. The serviceName used for the connector is used in the plugin manifest while creating the extension. This will take care of the necessary authentication.
The mode of authentication may vary depending on the application you are integrating into the eWidget. Identify the authentication method used by the third-party application and then pick one of the following methods supported by connectors in Zoho Mail:
- API key
- OAuth 1.0
- OAuth 2.0
You can create a connector for the extension you are building in the developer space using the following steps:
- Login to Zoho Mail
- Navigate to Settings >> Integrations >> Developer Space
- Select Connectors from the left menu
- Click on Create Connections to begin configuration
- In the New Custom Connection screen, enter the following:
- Service name - Enter the serviceName that you will be using in the plugin manifest.
- Display name - Enter a display name for your identification.
- Token type - Type of access token. The type defines how they are constructed. (Example: Bearer tokens, MAC tokens etc)
- Authentication type - You can select from API key, OAuth 1.0 or OAuth 2.0. Depending on the method you choose, you will be required to enter the required authentication details.
- Click Save
This connector is now created in your Zoho Mail account.
In order to test the connector you have created, you need to authenticate the connector.
- Navigate to the connector listing.
- Hover over the connector you wish to authenticate.
- Click on Connect.
- Complete the authentication steps to give Zoho Mail access to the third-party application data.
You can now test your connector.
While using the Invoke URL command, you will need to use the serviceName that was used while creating the connector. When any user installs the extension you have created, they will have to complete the authentication steps to give Zoho Mail access to the third-party application data. These steps are taken care of by the connector in the background.