Registering Your API Client Application in the Embarcadero Developer Network

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to Obtaining Authorization to Use the API

You must register your ER/Studio Team Server API client applications in the Embarcadero Developer Network (EDN) 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 in the EDN once, providing information such as the name and a description of your client application.

To register your application in the EDN you need to perform an API request with the following parameters:

Item Value

URL

http://teamserver.example.com/api/v1/registry/client

Method

POST

Headers

Content-Type

application/json

Body

{
    // Mandatory Fields

    "ednUser": "username", // Your EDN username.
    "ednpwd": "password",  // Your EDN password.

    "name": "My App",      // The name of your client application.
    "description":         // A description of your client application.
        "My custom API client application",

    "clientType": "1",     // The type of your client application, which may be any of the following:
                           // • Web Application ("0").
                           // • Native Application ("1").

    // Optional Fields

    "nativeType": "4",     // If you choose "clientType": "1", use this property to specify which platform your client
                           // application supports. You may use any of the following values:
                           // • Windows ("0").
                           // • Mac OS X ("1").
                           // • Android ("2").
                           // • iOS ("3").
                           // • Other ("4").

    "home":                // Your client application home page.
        "http://myapp.example.com",

    "image":               // A direct link to an image that represents your client application.
        "http://myapp.example.com/logo.png",

    "redirectURL":         // The OAuth 2.0 callback URL of your client application.
        "http://myapp.example.com/oauthcallback"
}

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

Personal tools
Next Version
Previous Versions
Product Family Wiki
Product Videos