Go Live

Request production access to an API, activate your app in the production environment, and manage API access contracts.

Table of Contents

  1. How do I request production access to an API?
  2. How do I go live in a production environment?
  3. How do I deactivate my app's API access in the production environment after I go live?
  4. How do I suspend my app's API access in the production environment after I go live?
  5. How do I resume API access in the production environment after I suspend it?

How do I request production access to an API?

After you have determined tested your app and are ready to go to production, you must request access to the production endpoint for the API. This is accomplished using the API Access Wizard.

Contract Generation and Approval:

After the API Access Request is completed, a contract post is created and the request is submitted to the Admin Team for approval.

Notes:

To request access to the production endpoint:
  1. Perform an API Search to target the API you would like to gain access to.
  2. Launch the API Access Wizard by selecting Access from the API Board page, or the API Details page. The 1. Select App page of the API Access Wizard displays
  3. Click the Add radio button of the App requesting access to the API. To sort the app information in ascending or descending order, click the App Name, Version, and Date columns.
  4. After making your selection, click Save, then Next. The 2. Endpoint page displays.
  5. In the Environment section, click the radio button (Production) of the API endpoint you would like to request access to.
  6. After making your selection, click Save, then Next.
  7. The 3. 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. Note that this page displays only if policies are defined as part of the deployment.
  8. Click Next. If the current API includes published legal agreements, the 4. Legal Agreements page displays.
  9. Review the Legal Agreements for the API and click Accept or Decline.
  10. 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.
  11. The API Access Request is processed and an "API Access Request" ticket is posted to the App Board for the related app with a "Pending" status. The ticket is identified with a Contract Request Icon. The API is also visible in the APIs Used section of the My Apps page.
  12. The Access Request is also posted to the APIs > App and App > APIs pages with an Access Requested status. Upon approval by the API Admin, the API Access Request status will change to Active. Access to the API is granted and the API is visible in the APIs Used section of the My Apps page.
  13. After this step, you must add the production endpoint URL to your app. Refer to the API documentation in the API > Documents section for more information.

For more information on managing connections, see How do I see the status of my app's connections to APIs?

Back to top

How do I go live in a production environment?

After the API Access Request for your app has been "Approved" and "Activated" the final step in the process is to activate. This is accomplished using the Activate function on the My Apps > APIs : Connections page.

To go live in a production environment:
  1. Navigate to My Apps > App > APIs. Your app will display with an "Activated" status. If it still has an "Approved" status, this means that the API Provider has not yet approved your API Access Request.
  2. To go live with your app, click Switch to Production. The "Switch to production request successful" message displays. Your app is now live.

Back to top

How do I deactivate my app's API access in the production environment after I go live?

If for any reason you would like to deactivate your live production environment, you can do so via the "API access request from <App Name> (App Version) for <API Name> in production environment" request located in your Dashboard or App Board.

To deactivate your live production environment:
  1. Navigate to your Dashboard or App Board and locate the "API Access Request" post associated with the app for which you would like to deactivate production.
  2. Click Cancel.

Back to top

How do I suspend my app's API access in the production environment after I go live?

If you would like to temporarily suspend your live app, you can do so using the suspend function. You can resume your go live state using the Resume function.

To suspend API access in the production environment:
  1. Navigate to your Dashboard or App Board and locate the "API Access Request" post associated with the app for which you would like to deactivate production.
  2. Click Suspend. At the prompt, enter a comment and click Confirm. The app is suspended and the Resume button displays.

Back to top

How do I resume my app's API access in the production environment after I suspend it?

If you have previously suspended your app's access to an API in the production environment, you can resume it using the Resume function.

To resume API access in the production environment:
  1. Navigate to your Dashboard or App Board and locate the "API Access Request" post associated with the app for which you would like to deactivate production.
  2. Click Resume. A "Resume this access request" comment box displays. Enter a comment and click Confirm. The app goes live in the production environment.

Back to top