Documentation menu

API client

Last updated on • Disponible en Français

For backend frameworks like Node.js, Ruby on Rails, Spring, Gin, and Django, you and your candidates will have access to a RESTful API client which you can use to test your candidate’s API design.

To access the API client, simply click on the API Requests tab in the top right of the screen.

API request tab is highlighted in the top of the right pad window.
Click on the image to make it larger.

The API client is divided into three sections:

The image shows an API request testing interface, likely within a coding or development environment. Here’s a detailed breakdown of the interface: 1. **API Request Section:** - At the top, there is a section for configuring the API request. The method selected is `GET`, and the endpoint being tested is `/test`. - The request body type is set to `JSON`. There’s an empty field below where the request body could be entered if needed. 2. **Response Section:** - Below the request section is the response area. The response shows a `200 OK` status code, indicating that the request was successful. - The response body is displayed in a "Pretty" format and contains a JSON object: `{"data": "Hello World!"}`. 3. **Request History:** - At the bottom of the interface, there's a "Request History" panel showing previous API requests. The history shows three `GET` requests made to the `/test` endpoint, with one including query parameters (`/test?id=lsdkj/30293&location=gotham_city`). Additionally, the interface includes tabs at the top for "Program Output," "Private Interviewer Notes," and "API Requests" (the currently active tab). There are also options at the bottom to provide feedback, adjust settings, or end the interview session.

Request window

The first part of the API client window consists of the following:

  1. A dropdown list of HTTP verbs
  2. The URL bar
  3. The Send button to dispatch your message to the endpoint(s) you created in the editor
  4. The Clear button to reset your API client window.
The API client window with a #1 next to the HTTP verb dropdown in the top left, a #2 next to the url bar in the top center, a #3 next to the send button at the right of the url bar, and a #4 next to the clear button which is to the right of the send button.

Body

You can set your body payload to JSON, Form, or Text in the dropdown:

JSON

Form

Text

A sample JSON message.
A sample form list with the names and values for two rows filled out.
To add a form row, click Add +. To clear a row from the form list, simply click on the garbage bin icon to the right of the row.
Random text in the text window for the request body.

Cookies

You can create cookies by selecting the Cookies tab below the URL. You have to option to enter in the following for the cookie:

  • Name
  • Value
  • Expires (expiration date)
  • Domain
  • Path
The request window with the cookies tab selected. Two cookies are entered with the name, value, expires, domain, and path fields filled out with sample data.

To add a cookie, simply click +Add. To remove a row, click on the garbage bin icon to the right of the row you want to remove.

Headers

You can add headers by selecting the Headers tab below the URL and then entering in the appropriate Name-Value pair.

The headers tab is selected with one row filled in with content-type for the name and application/json for the value.

To add a header, simply click +Add. To remove a row, click on the garbage bin icon to the right of the row you want to remove.

Params

You can add query parameters by selecting the Params tab below the URL and then entering in the appropriate Name-Value pair. Notice that when you add the parameters the URL will automatically populate with the appropriate syntax.

Params tab selected in the api client window. Two rows are filled out and are reflected in the url bar at the top of the window.

To add a new header, simply click +Add. To remove a row, click on the garbage bin icon to the right of the row you want to remove.

Response window

In the top right corner of the response window you can quickly see the server response status and response time:

A response window with an arrow pointing to the server status, which is "200 OK" and a response time of 47 ms.

Body

The response body will be in whatever format your endpoint is set up to produce. You do have the option to Pretty the response body for better readability:

Pretty toggle on

Pretty toggle off

Prettified json.
Raw JSON.

Headers

To view the response headers, simply click on the Headers tab:

The headers tab selected in the response window with theings like "connection", "date", and "content-type" filled out.

Request History window

You can review your request history and rerun old requests by selecting the Request History tab and then clicking on the previous request you’d like to view or rerun:

The Request History tab is shown with seven previous reqeusts shown with their HTTP verb and url displayed.

✅ If you try to click on a request history item while you have an unsent request at the top, you’ll get a modal prompting you to replace/clear the request window and replace it with the data from the request history item you just clicked on.

Modal that reads "you have an unsent request. navigating away from this request form will discard all current edits". below that two buttons, one that says "discard current edits" and another that says "return to form".

You’ll also be able to review the candidate’s Request History in the playback window once the interview has ended: