Skip to main content

Solutions

Law firms

Tax, audit & accounting firms

Corporations

Governments

Products

Legal

Trade & supply

Tax, audit & accounting

Corporate tax

Risk & fraud

Books

Recommended products

Questions? We are here to help.
Contact us

Purchase

Buy solutions

Buy books

Contact sales

Questions? We are here to help.

Resources

Insights

Events

Product training

Product communities

Developers

Applications

Create an application to call an API

Develop an application that interacts with APIs to access external services or integrate with other systems.
A user or machine application for APIs interacts with application programming interfaces (APIs) to access external services or integrate with other systems. Examples include web applications, mobile applications, desktop applications that need to access APIs on behalf of a customer.
note
Before creating an application, turn on the account ID at the API gateway and set up with the specific product access.

Select a gateway company

Before creating the application, select the gateway company.
  1. On the
    API Admin Applications
     screen, locate the
    Company
    dropdown.
  2. Select a gateway company from the list.
    • The dropdown displays all gateway companies associated with your account.
  3. Once you select the gateway company:
    • Only applications associated with that gateway company will display.
    • Any new application you create is added for the selected gateway company.
    • All subsequent actions (application creation, product selection, permissions, certificates, and rate limits) apply only within the context of that selected gateway company.

Create a user application type

A user application accesses APIs on behalf of a customer.
  1. Select
    Add Application
     on the
    Applications
     screen.
  2. Select
    User Application
     as the 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 redirects 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 you want the
    User Application
     to access.
  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 access.
    2. If you select
      Client ID and Client Assertion
      , select your certificate type as
      New Certificate
       or
      Re-use Existing Certificate
      .
      note
      The
      New Certificate
       needs to begin with
      -----BEGIN CERTIFICATE-----
       and end with
      -----END CERTIFICATE-----
      .
  5. Select
    Next
     after entering all 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, select the product and set permissions the user can access.
  9. Select
    Done
     to save your changes, or select
    Previous
     to go back to the last step.

This article applies to:

  • Product: ONESOURCE API Administration