How To Register Your API App

Description

Whenever you are using API Client applications with Team Server you must register this application with IDERA to ensure that the client ID of your client applications are not in conflict with the client IDs of any other Team Server API client application.

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

Steps To Register

To register your application follow the instructions below:

1. Create 2 GUIDs.
   • Use any GUID creator. ex: https://www.guidgenerator.com/online-guid-generator.aspx
2. Use a RESTClient application
   • ex: https://addons.mozilla.org/en-US/firefox/addon/restclient/
3. The first step is to POST the information. The information should be in this format
   • {“clientId”:””,”secret”:””,”description”:””,”home”:””,”image”:””,”clientType”:1,”nativeType”:0}
   • NOTES:
     • All fields are held within quotes. Remove the < and >
     • clientID is GUID_1 and secret is GUID_2.
     • Name is the client’s application name.
     • Description is the description of the application.
     • This can be multiple sentences.
     • Home is the URL for the customers application.
     • Image is the image for the customer application.
     • clientType is ALWAYS 1 nativeType is ALWAYS 0
4. Follow the format below in the REST client.
   • URL is the URL of the Client Team Server. NOTE: Include the port.
   • HEADER is required. Content-Type: application/json
   • The Body is what is created in Step 3.
   • Press “Send” and confirm that the response was successful.

Once the application is registered, perform the GET to confirm the POST was successful. Use GUID_1 from above in the url and press “Send”

NOTE: View the Response Body for the details.