Skip to main content

Solutions

Products

Recommended products

Questions? We are here to help.
Contact us

Purchase

Questions? We are here to help.

Resources

Applications

Create an application to call an API

A user or machine application for APIs is a software application or system that interacts with Application Programming Interfaces (APIs) to access external services, or integrate with other software systems. Examples are a web application, mobile application, desktop application, and more that needs to access APIs on behalf of a customer.
note
Before creating an application, the Account ID must be enabled at the API gateway and set up with the specific product access.

Create a user application type

A user application is an application that accesses APIs on behalf of a customer.
  1. Select
    Add Application
     on the
    Applications
     screen.
  2. Select
    User Application
     as your application type on the
    Application Details
     screen. This type of application is for a customer.
  3. Enter your information in
    Application Name
    .
  4. Enter the
    Callback URL
     of your application, which exchanges the authorization code received for an access token. Ensure that the URL includes https://.
    note
    The authorization service will redirect the user to the specified callback URL after they authorize your access request. This step is not needed if Alteryx is enabled.
  5. Mark the checkboxes in the Products section for the APIs that you want the
    User Application
     to have access to.
  6. Select
    Done
     to save your changes, or select
    Edit
     to go back to the last step. Otherwise, select the arrow and go back to the
    Applications
     screen.

Create a machine application type

A machine application doesn't require you to sign in to a product. The application uses a machine-to-machine approach to call product APIs.
  1. Select
    Add Application
     on the
    Applications
     screen.
  2. Select
    Machine Application
     as your application type on the
    Application Details
     screen.
  3. Enter your information in
    Application Name
    .
  4. In the Application Authentication section, select your authentication type as
    Client ID and Client Secret
     or
    Client ID and Client Assertion
    .
    1. If you select
      Client ID and Client Secret
      , mark the checkboxes next to the Products APIs you want the machine application to have access to.
    2. If you select
      Client ID and Client Assertion
      , choose your certificate type as
      New Certificate
       or
      Re-use Existing Certificate
      .
      note
      The
      New Certificate
       must begin with
      -----BEGIN CERTIFICATE-----
       and end with
      -----END CERTIFICATE-----
      .
  5. Select
    Next
     when you're done entering all your information.
  6. On the
    Group Setup
     screen, mark the checkboxes next to the
    Group Name
    , then
    Add
     or
    Remove
     for the current application type.
  7. Select
    Next
    .
  8. On the
    Permission Setup
     screen, choose the product and set permissions that the user has access to.
  9. Select
    Done
     at the bottom of the screen to save your changes, or select
    Previous
     to go back to the last step.

This article applies to:

  • PRODUCT: ONESOURCE API Administration