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.

API Explorer

To access the API Explorer:

  1. Go to any Project.
  2. Click Create New Test from the dropdown menu.
  3. Select Architect
  4. The New Test window will open. 

mceclip0.png

      5.  Click on the API Endpoint tab.

      6.  Click Start Test to open the API Explorer.

 

mceclip1.png

API_Explorer_3.png

-OR-

  1. Go to any Project
  2. Select Create New Test dropdown
  3. Select Architect

API_Explorer_1.pngCreate New Test popup will open. From the Web App tab, select the checkbox, then select Start Test.

API_Explorer_4.png

Once the Architect opens, select the record button to begin modeling.

API_Explorer_5.png

Select the plus icon  Plus.png, then select API.

API_Explorer_6.png

Once API is selected, a confirmation window will open. Select to Open in a new tab (if desired) then select Continue to open the API Explorer.

API_Explorer_7.png

The API Explorer will open:

API_Explorer_8.png

The API Explorer Request form contains the following fields:

  1. Destination
      1. Destination method (drop-down selection):
          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. XML
      2. JSON
  3. Request Method (drop-down selection)
      1. HTTP
      2. SOAP
  4. Follow Redirect (drop-down selection)
      1. Yes
      2. No
  5. Output Type (drop-down selection)
      1. Formatted Response
      2. Tree Response
      3. Raw Response
  6. Authentication - Add Authentication
      1. Basic Auth - Basic Auth is for authenticating a client to a primary application.
      2. OAuth 2 - A proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.
      3. Proxy - Normal proxy authorization involves the use of 'Proxy-Authorization' header for HTTP requests.
  7. Headers
      1. Name
      2. Value
      3. Add Another Header (optional - can add multiple)
  8. Parameters (name and value)
      1. Name
      2. Value
      3. Add Another Parameter (optional - can add multiple)
  9. Payload
      1. Payload Type (drop-down selection):
          1. Text
          2. XML
          3. JSON
          4. Text field - enter text
  10. Launch Request - starts the API request

Fill in the request details, then select Launch Request.

API_Explorer_9.png

API_Explorer_10.png

API_Explorer_11.png

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.

API_Explorer_12.png

Selecting Save Response will prompt the user to enter a key. Select Save to finish the API Response, or Cancel to cancel the request.

API_Explorer_13.png

 

JSON Explorer Tab

image__2_.png

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
image__3_.png