Can you connect external apps to Developer Instance?

burtmianus
Giga Contributor

Hello,

 

Complete novice here with a ridiculously short time to make something remotely tangible for testing, so apologies for the noddy level.......

 

Is it possible to connect external apps to a Developer instance to make API calls etc.? I have a SOAR platform that will need OAUTH access to the Developer instance of ITSM that I have, and I have a firewall management platform that needs API access. Is this possible for a developer instance? I have found that going direct to the devxxxxxx.service-now.com instance address and trying to login to it does not work, i have to login via the developer.servicenow.com portal.

 

If you can do this, then please can someone tell me how you create an API user that can interact with the ITSM workspace?

 

Thanks

3 REPLIES 3

Paul Deonarine3
Tera Expert

Yes, it is possible to connect external apps to a personal Developer instance of ServiceNow to make API calls using OAuth authentication.

To do this, you need to first configure an OAuth application in your ServiceNow instance. This will generate the necessary OAuth client ID and secret that your external apps will use to authenticate with your ServiceNow instance. You can configure an OAuth application by following these steps:

  1. Log in to your ServiceNow Developer instance.
  2. Navigate to System OAuth > Application Registry.
  3. Click the New button to create a new OAuth application.
  4. Enter a name for your application and select the appropriate OAuth version.
  5. Under Authorized Redirect URIs, enter the URL where your external app will be redirected after the user authorizes the OAuth access.
  6. Click the Submit button to save your OAuth application.

Once your OAuth application is configured, you can create an OAuth profile to grant your external app access to the ServiceNow API. Here are the steps to create an OAuth profile:

  1. Navigate to System OAuth > Application Registry.
  2. Click on the name of the OAuth application you created earlier.
  3. Click the New button to create a new OAuth profile.
  4. Enter a name for your profile and select the appropriate OAuth version.
  5. Under OAuth Scopes, select the ServiceNow API endpoints that your external app will be able to access.
  6. Click the Submit button to save your OAuth profile.

Now that you have an OAuth client ID and secret, and an OAuth profile that grants access to the ServiceNow API, you can use these credentials in your external apps to authenticate and make API calls to your ServiceNow instance.

To create an API user that can interact with the ITSM workspace, you can create a new user record in your ServiceNow instance and assign the necessary roles and permissions to the user. Here are the steps to create a new user:

  1. Navigate to User Administration > Users.
  2. Click the New button to create a new user.
  3. Enter the necessary information for the user, including their username, password, and email address.
  4. Under Roles, assign the necessary roles to the user. These roles will determine the user's permissions in the ServiceNow instance.
  5. Click the Submit button to save the user record.

Once you have created the API user, you can use this user's credentials in your external apps to authenticate and make API calls to your ServiceNow instance.

Thanks for this answer. Could you also link to the documentation relating to authenticating and sending requests via external applications as well? There are many versions of the Rest API in the documentation and it is a bit hard to understand which API corresponds to external applications

Ratnakar7
Mega Sage
Mega Sage

Hi @burtmianus ,

 

Yes, it is possible to connect external apps to a developer instance of ServiceNow to make API calls. Developer instances are fully functional instances of ServiceNow, and you can use them to test and develop integrations with other systems.

To create an API user that can interact with the ITSM workspace, you can follow these steps:

  1. Navigate to "User Administration" in ServiceNow and create a new user account for the API user.

  2. Grant the user the necessary roles and permissions to interact with the ITSM workspace. Depending on the specific tasks the API user needs to perform, you may need to grant them roles such as "rest_service", "soap_service", or "web_service_admin".

  3. Generate an OAuth token for the API user. In the ServiceNow instance, navigate to "System OAuth" and create a new OAuth token record. Configure the record with the necessary details, such as the client ID and secret, and associate it with the API user you created in step 1.

  4. Configure the external app to use the OAuth token to authenticate with the ServiceNow instance. The exact steps will depend on the specific app you are using, but typically you will need to provide the OAuth token details (client ID, secret, token endpoint URL) to the app and use them to authenticate and make API calls.

  5. Test the integration to ensure that the API user is able to interact with the ITSM workspace and perform the necessary tasks.

 

If my response helps you to resolve the issue close the question by Accepting solution and hit 👍thumb icon. From Correct answers others will get benefited in future.

 

Thanks,

Ratnakar