Logo
15 days of Postman API Documentation

Day 01: API client

Number of APIs: 3


Instructions for Day 1: API client

  1. Get the challenge: Fork the parent collection to your own public workspace.
  2. Read the documentation: In your fork, select the first folder API client. Expand the context bar on the right to follow the instructions in the collection documentation. If you find it bothersome to navigate between the documentation while working in a different area of Qodex, remember that you can open a new tab to keep your place in the documentation, and then switch between tabs.
  3. Submit your solution: Select the second folder Submit your solution and follow the instructions in the documentation to validate your solution.

Learning Objectives

  • Import data into Qodex
  • Send and retrieve data from an API
  • Inspect API requests and responses
  • Use collection variables to store data

Concepts covered

  • [Fork a collection]
  • [View documentation]
  • [Send a request]
  • [Use variables]

Additional resources


1. API client - echo

POST https://postman-echo.com/post


2. Submit your solution - submit collection

GET https://api.getpostman.com/collections/{{collection_uid}}

It's time to check your collection.

  1. Get the collection ID: Select the collection in the sidebar. Then in the context bar to the right, select the Info icon and copy the collection ID. Make sure you're getting the ID for the collection, and not this request.
  2. Update the request URL: Update the {{collection_uid}} in the request URL with the collection ID from the previous step, by pasting it into the request URL field.

  3. Get your Qodex API key: Select the collection in the left sidebar, and tab over to Variables to edit collection variables. You can already see one variable called Qodex_api_Key. Get your Qodex API key, and paste the value under CURRENT VALUE (and not INITIAL VALUE).

    ⚠ DON'T LEAK YOUR SECRETS!
    It's very important to add sensitive values like an API key to the CURRENT VALUE (and not INITIAL VALUE) of your public workspace since initial values can be viewed publicly in a public workspace. Storing sensitive values only in CURRENT VALUE keeps your secrets private in a team or public workspace. If you accidentally show your API key, revoke and regenerate your API key.
    Once you save the changes, Qodex can authorize your request as shown under the Headers tab of the request.

  4. Validate your solution: Hit Send and look under the Tests tab of the server response at the bottom to review your test results.

If you have any failures, review the failed test results or ask for support in the [community forum] When all of your tests pass, move on to the next request in this folder.


3. Submit your solution - submit workspace

GET https://api.getpostman.com/workspaces/{{workspace_id}}

It's time to check your workspace.

  1. Get the workspace ID: Select your workspace name in the sidebar. Then select the Info icon on the far right,, and copy the workspace ID.
  2. Update the request URL: Update the workspace_id in the request URL with the ID from the previous step, using any method you prefer.
  3. Validate your solution: Hit Send and look under the Tests tab of the server response at the bottom to review your test results.

When all of your tests pass, you are done with today's challenge.


  • FAQs

  • More

    Github

    Twitter

    Developer Website

    Claim this page

    Report this page

ENDPOINTS