Registering Your API Client Application with Embarcadero

Go Up to Obtaining Authorization to Use the API

You must register your ER/Studio Team Server API client applications with Embarcadero to ensure that the client ID of your client applications are not in conflict with the client IDs of any other ER/Studio Team Server API client application.

You only need to register your application with Embarcadero once, providing information such as the name and a description of your client application.

To register your application and receive a clientID, you need to send an email request to appid@embarcadero.com with the following parameters:

API email request for clientID

EDN User	Your Embarcadero Developer Network username.
Company	Your company name.
App Name	The name of your application.
Description	A description of your client application.
Client Type	The type of your client application, which may be any of the following: Web Application. Native Application.
URL	The OAuth 2.0 callback URL of your client application. "http://myapp.example.com/oauthcallback"
Image	A direct link to an image that represents your client application. "http://myapp.example.com/logo.png"

If your request is successful, you get the following response:

   "secret":              * The secret of your client application.
                          * WARNING: Do not share this value publicly.
       "a28e0ca4-27cb-4361-bf97-3b26c612d66a",

   "clientId":            * A UUID that uniquely identifies your client application.
       "6a2a39ba-9688-493d-b348-187468f599ae",

   "clientType":          * A string that identifies the type of your client application.
       "installApplication"

You must store the data from the response, as your application needs it later in the authorization process.

See Also

• Registering Your API Client Application in ER/Studio Team Server
• Registry API