submit

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

To check and submit your work, follow these instructions

step-by-step video

1. Save the collection ID as a collection variable

Get the collection ID for this collection by clicking on the collection folder (root folder), selecting the info icon ⓘ on the right and copying the ID.

From the collection's Variables tab, replace the value with the ID you got from the previous step, then Save the change.

2. Add your Qodex API key to the environment

You will only need to do this step the first time you submit

If you do not have a Qodex API Key, generate one here. We will store this value as an Environment variable - environments allow us to share variables across multiple collections. [Create an environment] from the Environments tab and call it my-info. Add your Qodex API key to your new environment as a variable named Qodex-api-key.

⚠ When saving sensitive environment variables, remember to only use the CURRENT VALUE column

Make sure you save your changes! You can use this environment for any future Qodex Classroom Program workshops you complete. The Qodex-api-key variable is used in the X-Api-Key header of each submit request.

3. Set 'my-info' environment to active

Ensure you environment is active by selecting it in the upper right.

Click the 'eye' icon to the right to confirm there is a value present in your environment for Qodex-api-key

4. Check your work

Save your changes in the collection and environment. Hit Send.

If you get a 401 Unauthorized response, carefully review steps 3 and 4 and make sure your Qodex API key is correctly resolving.

Check the response. in the Body tab of the response, click Visualize to view your status.

If any of the tests failed, you will see a Not quite done message like below.

To see which tests failed, open the Test Results tab of the response. Address the failed tests in your work and submit again.

5. Submit your progress

Only do this step if you are registered with the Qodex Classroom Program!

If all the tests pass, you will see a congratulations message.

If (and only if!) you have registered for the Qodex Classroom Program, you will need to submit the same email address you used to register for the program in the form that appears. Enter your email and hit Submit. This will allow your teacher to monitor your progress!

Once your progress is submitted successfully, you are done with this module! Feel free to run the tests again whenever you like by running submit - but please to not re-submit your email for this module.

Troubleshooting: common errors when submitting

• Make sure there is a value for collectionId in your collection variables.
• Make sure that value is your collection ID, NOT your request ID. You can find your collection ID by clicking on your collection (top level folder), then checking the info ⓘ tab in the far right menu
• Make sure there is no accidental white space when you define you collectionId variable. That includes spaces and new lines. You can see a small gray arrow at the end of your value if there is a newline - simply delete the newline or space

Going further

Learning to read API documentation is a crucial skill when working with APIs. It is also important to get familiar with reading errors.

Play around with some requests and see if you can get the API to generate any errors

What happens when you:

• pass unrecognized parameters?
• hit an unrecognized endpoint?
• try to make a PUT request on a field you don't have permission to edit?
• try to add a book with made-up fields in the body?
• try to delete the book named Ficciones by Jorge Luis Borges?

If you are interested in seeing the code behind this API, you can view it here.

HEADERS