Step 1: Set up Bridge
Setting up Bridge for Mac/Linux
Once the Bridge file is downloaded as in the
previous step, save it in a new directory and open your Terminal.
-
In the terminal, unzip the downloaded file in a new directory by typing the following command:
-
unzip <file-name>
Note that
Java is bundled with the zip file. If you do not have Java installed in your host, go to, conf/wrapper-bridge.conf and change
wrapper.java.command
into
jre/bin/java.
-
Go to the bin directory and run the Bridge using the commands:
-
(./start.sh) or (./bridge.sh start)
To test the connectivity of the bridge before installation, go to the bin directory and execute
./bridge.sh
console.
-
Logs will be displayed in the current console.
-
If you close the window, the Bridge will be stopped.
Install daemon for Mac/Linux
To
restart
the Bridge automatically when the host is restarted, install Bridge as a daemon process. This in turn installs the Bridge as a daemon service and adds auto-start scripts to
init.d
directory. Your directory must be the root for this action to occur.
Go to the bin directory and execute:
-
sudo ./bridge.sh install
-
sudo ./start.sh
Note: You cannot install more than one Bridge service as a daemon on a Linux host. This is a limitation of the Tanuki wrapper service.
If the Bridge starts successfully,
-
Open your browser and access http://<hostname>:8500 (if it is same host, then you can mention it as localhost).
To get hostname, use
hostname
command.
-
8500 is the default port. You can change it in conf/config.xml. Restart the Bridge if you need to change the port.
-
You can set proxy details in conf/config.xml. Restart the Bridge to update your changes.
If the Bridge fails to start,
-
You can verify the reason in wrapper logs (logs/wrapper.log) or bridge logs (logs/logs.txt)
-
Mostly, the startup fails if the webserver port is occupied by some other application.
Setting up Bridge for Windows
Once the Bridge file is
downloaded, save it in a new directory and open your Terminal.
-
In the terminal, unzip the downloaded file in a new directory by typing the following command:
-
unzip <file-name>
Note that Java is bundled with the zip file. If you do not have Java installed in your host, go to, conf/wrapper-bridge.conf and change
wrapper.java.command
into
jre/bin/java.exe
-
Go to the bin directory and run the Bridge using the commands:
-
bridge.bat install
and
bridge.bat start
To test the connectivity of the bridge before installation, go to the bin directory and execute
bridge.bat console.
-
Logs will be displayed in the current console.
-
If you close the window, the Bridge will be stopped.
Install multiple Bridges in a single Windows host
To install multiple bridges, follow these steps:
-
Execute
Open conf/wrapper-bridge.conf
-
Give an unique name in
wrapper.name
and
wrapper.displayname
in all the bridges you want to run and start the Bridge.
If the Bridge starts successfully,
-
Open your browser and access http://<hostname>:8500 (if it is same host, then you can mention it as localhost).To get hostname, use
hostname
command.
-
8500 is the default port. You can change it in conf/config.xml. Restart the Bridge if you need to change the port.
-
You can set proxy details in conf/config.xml. Restart the Bridge to update your changes.
If the Bridge fails to start,
-
You can verify the reason in wrapper logs (logs/wrapper.log) or bridge logs (logs/logs.txt)
-
Mostly, the startup fails if the webserver port is occupied by some other application.
Step 2: Create a new client
Client ID and Client Secret can be generated by creating a new client using Zoho API Console. Hit the URL
https://accounts.zoho.com/developerconsole
.
To create a new client, click the + button next to the Client ID in the previous step.
-
Enter the
Client Details
:
-
Client Type: Select the type of application as
Server-based Applications
.
-
Client Name: Enter a client name.
-
Homepage URL: Enter the URL of homepage
-
Authorized Redirect URIs: Enter the Redirect URI populated in the previous section. (E.g.,
http://localhost:8500/account/authcallback
)
-
Click
Create
.
The
Client ID
and
Client Secret
will be generated.
You can also use the same OAuth credentials in different data centres by enabling
Multi-DC
option in the
Settings
tab.
Enter the web server port (e.g.,
http://<hostname>:8500) in your browser
, a new tab opens in the local port. Configure the client details here.
-
Enter the client details:
-
Accounts Domain: Select the domain you use, either localzoho.com or zoho.com.
-
Client ID: Enter the client ID generated in the pervious step.
-
Click + to create a new client.
-
Client Secret: Enter the client secret generated in the pervious step.
-
Redirect URI: A redirect URI will be automatically populated.
-
Click
Save
.
You will now be redirected to a confirmation page. Click
Accept
.
Step 3: Login to Bridge
Once you complete the configuration, you will be prompted to verify your organization. Enter the following details:
-
Organization Name
: Enter your Qntrl organization name for which this Bridge is being configured.
-
Bridge Name
: Enter the Bridge name created in
Step 1
.
-
Registration Key
: Enter the registration key of the created Bridge. This is available under
Configuration
section of Bridge details.
-
Click
Start Server.
Once the verification is done, you will
be redirected to the login page.
-
User Name: Provide a user name.
-
Password: Enter a password.
-
Confirm Password: Re-enter the password.
-
Click
Sign Up.
You will now be navigated to Bridge's message list page. You can view all the Bridge calls here.
If you are unable to sign up,
-
Refresh the Bridge list page to view the current status your Bridge.
-
Check if you have filled the right data.
-
Click the Verify Organization button again, and try to refresh.
Step 4: Test the Bridge
To test the Bridge, use the Messages module.
-
Navigate to
and select
Messages
under
Bridge.
-
Click the
New Message
button.
-
Fill the details:
-
Title: Enter a title for your message.
-
Bridge: Select the Bridge you would like to test.
-
Module: Select the module in which you would like to test the Bridge.
-
Type: Select the message type.
-
Synchronous: Executes tasks in the same request and provides response.
-
Asynchronous: Executes tasks in the background and updates response automatically.
-
Request Data: Enter the JSON request data.
-
Response: If the type is Synchronous, you will be able to view the response to the request.
-
Click
Execute.
Once the message is executed successfully, you must be able to view a server call entry in the message list of your local bridge.