Quick Start (App Developer)


How do I create a new app and configure it to consume APIs?

Step 1: Add New App

The first step in the process is to add an app. To do this:

  1. From the Plus Menu, select Add a New App. The Add App Info page displays.
  2. On the Add App Info page, specify the App Name, Version ID, Tags, Visibility (Public/Private), App Description, Version Description, and App Icon. All information here displays on your customer-facing App description.
    • You can optionally upload an icon to uniquely identify your app. See How do I upload and crop icons? for more information.
    • Your App description should include marketing, functional, and use case information.
  3. After completing your entries, click Save. The app information is saved and posted to the App Details page. You can click Edit to update the App Name and  Description.
  4. To exit this operation, click Cancel.
  5. For more details information, see How do I create a new app in SOA Software Open?

Step 2: Provision App with Authentication Key

Next, you must provision the app with an authentication key. The Security section of the App Details page includes Shared Secret and Public Key Integration options for generating the credentials required to authenticate your app. A shared secret is automatically generated as part of the Add a New App creation process. If you prefer to use PKI keys, you can generate a Certificate Signing Request and upload it.

See App Security to determine which option best suits your requirements, configure the credentials, and continue to Step 3: Request API Access.

Step 3: Request API Access

  1. Target an API you would like to add to your app. The API Details page displays.
    • The Access function is available on Search > API Details.
  2. Click Access. The API Access Wizard launches and the Select App page displays.
  3. In the Add column, click the radio button of the App Version you would like to request API Access for.
  4. Click Next to continue. The Endpoint page displays and presents a list of endpoints available for the current API (i.e., Sandbox or Production). Click the radio button of the of the environment you would like access to.

    Note: You must perform a separate access request for sandbox and production environments.
  5. Click Next to continue. The Policies page displays. Here you will select the Quality of Service (QoS) policies you would like to use to monitor the API service level. To select a policy, click the checkbox in the "Select" column of each policy you would like to assign to the current API.
  6. Click Next to continue. If the current API includes published legal agreements, the Legal Agreements page displays.
  7. Review the Legal Agreements for the API and click Accept or Decline.
  8. The selected API may require acceptance to multiple legal agreements. If acceptance of multiple legal agreements is required, click on the tab to view each legal agreement. Note that all legal agreements must be accepted in order to proceed. If no additional legal agreements require acceptance, click Submit. Access to the API is granted and the API is visible in the APIs Used section of the My Apps page.

Step 4: Build App and Configure App ID

The next step is to build your application and integrate the Sandbox Endpoint, App ID, and Shared Secret / or PKI Key. This enables the ability to send requests from your application using the App ID assigned during the app creation process.

To enable your app to send requests:

The App Security topic provides information on how to configure the App ID. You can access the topic here: App Security

Step 5: Complete App Testing in App Sandbox

The next step is to set up accounts and data in your sandbox testing environment and test your app.

Step 6: Request Production Access

After you've completed testing, and determine its time to upgrade your access to use the production endpoint, you can submit a request for production access.

To request production access:

  1. Navigate to the API Details page of the API you would like to request production approval for.
  2. Click Access. The API Access Wizard launches and the Select App page displays.
  3. In the Add column, click the radio button of the App Version you would to like API Access for.
  4. Click Next to continue. The Endpoint page displays and presents a list of endpoints available for the current API (i.e., Sandbox or Production). Click the radio button of for the "Production" environment.
  5. Click Next to continue. The Policies page displays. Here you will select the Quality of Service (QoS) policies you would like to use to monitor the API service level. To select a policy, click the checkbox in the "Select" column of each policy you would like to assign to the current API.
  6. Click Next to continue. If the current API includes published legal agreements, the Legal Agreements page displays.
  7. Review the Legal Agreements for the API and click Accept or Decline.
  8. The selected API may require acceptance to multiple legal agreements. If acceptance of multiple legal agreements is required, click on the tab to view each legal agreement. Note that all legal agreements must be accepted in order to proceed. If no additional legal agreements require acceptance, click Save. The API Access Request is submitted and the API is visible in the APIs Used section of the My Apps page.
  9. Select My Apps > APIs to verify the current status of your app. For production environments, the status is usually "Approved" and the API Provider will typically require an additional step to update the status to "Activated."
  10. See How do I manage API connections? and How do I go live in a production environment?

Step 7: Update Application with Production Endpoint

After you've been approved for production access and your status app status is "Activated," you must then update your app with the production endpoint URL. See App Security for more information.

Step 8: Go Live

After you add the production endpoint URL to your application, your app is ready to go live in the production environment.

Back to top