Registering an OAuth Client
Before an application can make a secure request from a Zoomdata server, it must be registered with the server as one of its clients. Typically, each application is registered as a client distinct from other existing clients. To register a client application, you must have access to the supervisor login for the Zoomdata server. If you do not have access to the supervisor login, you can ask your Zoomdata server supervisor to assist you in completing these steps to register your application as a client app of your Zoomdata server.
The following steps will help you register your application as a client of a Zoomdata server.
Use Postman or another REST API client application to make the following REST call to the Zoomdata server that will serve your client application.
POST to <yourserver>/<yourpath>/api/oauth2/client
yourserveris replaced with your server's DNS or IP address, together with any necessary port number
yourpathis replaced with your Zoomdata server's path, usually zoomdata
Be sure to:
Use the content type
application/vnd.zoomdata+json, application/vnd.zoomdata.v1+json, <etc.>, depending on the REST API version number that you want to use. For more information about Zoomdata's REST API versions, see REST API Overview.
Use basic auth and provide the
supervisorID and the supervisor's password.
Provide the required JSON object in the body of the REST request. You can find the exact JSON object requirements for your API version number at:
Typically, the request body's JSON object looks something like this:
clientnameis replaced by a client name of your choice to use for easy reference.
registeredRedirectURIskey is supplied with an array listing all paths to which the Zoomdata server may redirect the user's browser after the user has logged in granting permission to the Zoomdata client application.
The response body of the REST call is a JSON object that provides keys similar to those in the request body. The value of each key verifies the correct implementation of the requested value. Additionally, the HATEOAS link objects are added into the response body. The most important difference is that the
clientIdkey is supplied with a value by the Zoomdata server. A typical clientId looks something like:
This clientId is used in the following steps.
- Embed the client ID in your application so that it can be used to request access tokens for secure transactions. In most cases, doing so means assigning the clientId string to a variable or to a member of a JSON object.
After you have register your application as an OAuth client, your application can request an access token.
Was this topic helpful?