API Explorer

The API Explorer is used to perform specific tasks using service requests to the server via the API and the server processes the API call before returning a response. APIs enable a user to develop any kind of web application having all possible CRUD (create, retrieve, update, delete) operations.

Access the API Explorer

1. Go to any Project.
2. Click Create New Test from the dropdown menu.
3. Select Architect.
4. The Create New Test window will open. Click the API Endpoint tab.
5. Click Start to open the API Explorer.
6. The Architect will launch along with the API Explorer.

-OR-

1. Go to any Project.
2. Select Create New Test dropdown.
3. Select Architect.
4. From the Web App tab, enter the URL for the site under test, confirm no production credentials are to be used, enter any further information, then click Start.
5. Once Architect is launched and you have begun recording, click the plus icon.
   
6. Click API under Tools.
   
7. Select Open in a new tab (if desired), then click Continue.
8. The API Explorer will open along with Architect.

API Explorer Request Form

1. Destination (drop-down selection):
   1. 1. GET - Use GET requests to retrieve resource representation/information only.
      2. POST - Use POST Request to create new subordinate resources.
      3. PUT - Use PUT APIs primarily to update an existing resource.
      4. DELETE - DELETE APIs are used to delete resources.
      5. URL - enter URL
2. Response Type (drop-down selection):
   1. 1. XML
      2. JSON
3. Request Method (drop-down selection):
   1. 1. HTTP
      2. SOAP
4. Follow Redirect (drop-down selection):
   1. 1. Yes
      2. No
5. Output Type (drop-down selection):
   1. 1. Formatted Response
      2. Tree Response
      3. Raw Response
6. Authentication - Add Authentication
   1. 1. Basic Auth - Enter the Username and Password to authenticate directly to a primary application.
      2. OAuth 2 - Enter the access token in a URL parameter or HTTP header, this protocol allows users to grant third-party Providers (Google, GitHub, and others) application access to the user's protected resources, without necessarily revealing their long-term credentials.
      3. Proxy - Enter the IP address and Port of the proxy server, authorization involves the use of 'Proxy-Authorization' header for HTTP requests.
      4. Certificate - Add and manage SSL Certificates, a digital authentication of a website's identity which enables an encrypted connection.
7. Headers
   1. 1. Name
      2. Value
      3. Add Another Header (optional - can add multiple)
8. Cookies
   1. 1. Name
      2. Value
      3. Add Another Cookie (optional - can add multiple)
9. Parameters
   1. 1. Name
      2. Value
      3. Add Another Parameter (optional - can add multiple)
10. Payload (drop-down selection):
    1. 1. Text
       2. XML
       3. JSON
       4. Text field - enter text
11. Launch Request - starts the API request

Create Request

1. Enter the request details, then select Launch Request.
2. The response results will populate. Under Response Data tab, select the + to view root details. At this point, select either Save Response or select New Request.
3. Selecting Save Response will prompt the user to enter a key. Select Save to finish the API Response, or Cancel to cancel the request.

JSON Explorer Tab

Use $. in the Enter Path field to access objects in the resulting JSON. For example, if you have an object called coord (for coordinates) with a name/value pair beneath called lon (for longitude), you could access it with $.array.coord.lon