Create service provider applications

To access the API of a service provider, you must create an application with that service provider.

Creating an application provides you with a consumer key (also known as an API key or application key) and a consumer secret (also known as an API secret or application secret). When you create the OAuth client, you need both the key and secret to configure the target system and application authorization.

To create an application, log in to the developer community of the service provider, select Create New Application, or a similar option, and fill out the required information.

See Service providers. See also Register out-of-band applications.

In this topic, we show how to add applications using the service provider X (formerly Twitter) as an example.

1. Log in to https://developer.x.com, create a new account if necessary, and click Create an app.

2. Enter the required information, such as the name and description of the application, and read through the terms of service before accepting.

   One of the fields is a Callback URL. This is the URL that X redirects a browser to after the user has accepted to let your application interact with the X account on the user's behalf.

   If creating an application that will be registered as out-of-band, leave the Callback URL blank. See Register out-of-band applications.

   For in-band applications, this field must be set to the path OAuthCallback in the folder where Management Console is deployed.

   For example, if running with an embedded Management Console, it runs at http://localhost:50080/.

   For most service providers you would direct the callback URL to http://localhost:50080/OAuthCallback. However, X and some other service providers do not allow a callback URL containing localhost. Use http://127.0.0.1:50080/OAuthCallback instead.

   

   If required by the service provider, you must specify the hostname or non-loopback IP address of the computer on which you are running Management Console. Because the page is loaded by the browser of the authenticating user, this cannot be a public hostname or IP address.

   All service providers require an HTTPS connection if the IP address is other than 127.0.0.1. In this case, the Management Console must also be configured to use SSL. For more information, refer to the Tomcat documentation in the Tungsten RPA Administrator's Guide.

   After creating the application, a summary of the application appears. You must copy some of these values into the Management Console.

3. Open Management Console in a browser, using the same IP address or hostname that was entered as the callback URL.

   In this example, we directed the browser to http://127.0.0.1:50080/.

4. To create authentication for accessing the applications, see Vault and Configure OAuth clients.