# Configuration

There is no charge to access DEAPI/RAPI in the Pilot and Stage environments. To use either API, you must enable the Reporting API in the Edge Marketplace. Navigate to Admin > Tools > Edge > Marketplace. Search for and click on the Reporting API tile. Click the Install button to get started. Accept the terms and conditions and then click on Configure Now. Navigate to Admin > Tools > Edge > API Management, ensure the toggle for Reporting API is turned on, then follow the steps in the next section to get your API credentials.

For Production access, submit a purchase inquiry through the Marketplace. Navigate to Admin > Tools > Edge > Marketplace. Search for and click on the Reporting API. Click the Purchase Inquiry button to get started. Once you submit the inquiry, your Cornerstone Client Executive will reach out to you with next steps for completing the purchase and enablement process. Once that is completed, follow these steps to get your API credentials.

To register or update a new OAuth 2.0 Application:

  1. Log in to your portal. Ensure you have the 'Edge APIs - Manage' security permission.

  2. Navigate to Admin > Tools > Edge > API Management > Manage OAuth 2.0 Applications.

  3. Click on Register New Application if creating a new application, or click an existing application's name if updating/viewing its permissions. The following fields are available for configuration:

    • Application Name. If multiple applications will be used to manage access to different endpoints, be sure to provide a descriptive name.
    • User ID. Reference ID of application user that has 'Reporting API - Read Only' security permission.
    • Access Token Validity Period. Validity period of the OAuth 2.0 access token issued by Cornerstone in seconds (maximum = 86400 seconds = 24 hours).
    • Endpoint scopes/permissions. Select Reporting API in the dropdown list. You can associate specific endpoints to the application by selecting them from the list. Data Exporter API endpoints start with the prefix "obj", while Reporting API endpoints strat with the prefix 'vw_rpt'.
      • Tip: Type 'obj' into the filter textbox to only see DEAPI endpoints. You can then Select All using the checkbox below the list.
      • You should limit the scope of your OAuth 2.0 application to just the endpoints you need access to. You should also include 'obj_metadata:read' if you wish to access and review DEAPI extended metadata information like field filter options, relationship diagrams, and delta capabilities.

  4. Be sure to click Register Application and/or Save Changes when done.

  5. Copy the Client Secret and Client ID and use it in your external application that needs access to the DEAPI.

CSOD Reporting Environments