Sandbox

Create Sandbox APIs

• Login to the site as a Portal Admin

• Navigate to Dashboard > API Administration > Content > Add Content

• Click on APIs and enable Sandbox API

• Enter the following details:

  1. Title

  2. API version

  3. API image

  4. Add endpoint : Upload a swagger file (json/yaml)

• Click on the Save button to create the Sandbox API

Create Sandbox

• APIs listing page to provision sandbox:

  1. Login as an API Manager

  2. Navigate to Dashboard > API Testing > Sandbox APIs to provision the APIs

• Navigate to Dashboard > API Testing > Sandboxes page and click Add Sandbox to create one

1. Step 1 :

   1. Enter the following details :

      1. Application Name

      2. Select the API Node for which the Sandbox will be provisioned

      3. Check on Swagger File from API Nodes based on the requirement (3.0 and above are supported)

   2. Click on the Next button to go to Step 2

2. Step 2 :

   1. Select the Policy to be applied to the API.

   2. There are security policies Spike Arrest, Quota Policy, Verify API Keys, JSON Threat Protection, OAuthV2

      1. Spike Arrest : Protects against API traffic surges

      2. Quota Policy : Restricts the number of API requests based on the configured period of time

      3. Verify API Keys : Ensure the uploaded Open APISpec contains the API security definition

      4. JSON Threat Protection : Mitigates risks in the request payload JSON content

      5. OAuthV2 : Ensure the uploaded Open APISpec contains the OAuth 2 security definition

   3. Click on Finish

   4. Consumer key secret generated and Sandbox provisioned

   5. After sandbox creation goto sandbox listing page from there APIM manager can download the swagger, edit the rules and see the access keys

   6. Edit rules page

   7. On edit rules page APIM manager can update the strategy

   8. For every endpoint, APIM manager can update the strategy. When strategy is SATIC APIM manager can able to set the response payload

   9. When APIM manager will update strategy to DYNAMIC then he can able to set the rules and update the existing one

   10. For CANNED,BACKENED and REST only APIM manager to select the dropdown strategy will get update

Decommission the Sandbox

1. Login as APIM manager

2. Navigate to Dashboard > API Testing > Sandbox APIs

3. Click on Decommission, confirmation popup is displayed. when click on button delete it will decommission the sandbox

Sandbox access request

1. Login as portal consumer

2. Navigate to Dashboard > Find Your APIs > API Discovery

3. Click on particular API and goto the Sandbox tab. Sandbox form is coming for partner admin only and partner admin only can request sandbox access.

4. To provide access login as portal admin. Navigate to Dashboard > Apps > Partners and add member in active partner. Give role as Partner Admin

5. Login as portal consumer. Click on particular API and goto the Sandbox tab

6. After submitting form. Success message is displayed

7. Once sandbox access is approved developer with role partner admin and partner member both can able to view access keys and dapper UI

8. Developer can upload the seed data, they can download seed data sample file also and upload seed data should be in csv file format and not allowing to upload more that 1 MB data

Sandbox Access Approval

1. Login as APIM manager

2. Navigate to Dashboard > API Testing > Access Approvals

   APIM manager can approve and reject the sandbox access request

Revoke the sandbox

1. Login as APIM manager

2. Navigate to Dashboard > API Testing > Revoke Sandbox

3. After click on Revoke the popup is displayed for confirmation

4. After click on Revoke button of popup sandbox will get revoke

Reinstate the sandbox

1. Login as APIM manager

2. Navigate to Dashboard > API Testing > Revoke Sandbox

3. Click on Reinstate the popup is coming for confirmation

4. After click on Reinstate button of popup sandbox will get active again.

Sandbox DNS Settings

1. Login to the site as a Portal Admin

2. Click on menu Sandbox DNS Settings under sandbox menu

3. There are two ways to set the DNS

4. If portal admin will check "Use Default DNS system". It will take default DNS of system

5. If portal admin are not using default one, we need to upload the certificate and key and fill domain name and submit the form then the DNS will get register

6. The allowed types for certificate and keys are .cer,.pem

7. Portal admin get reminder for certificate expiration

Oauth Config

1. Login as Portal admin

2. Navigate to Dashboard > API Testing > Oauth2 Configuration

3. There are three option given for Oauth configuration: Authorization code, Password Credentials, Client credentials

4. Portal admin can check the checkboxes and fill the base url field and submit the form