Documentation
Feedback
Guides

Getting Started
Introduction
Making your first request
Learn how to make an API request

Let's test a simple GET call to see if you receive a 200 OK response.

Check out the following example, where we use the Try It feature in the API Reference of these Developer Docs to try a GET Category request. The {{appKey}} and {{appToken}} in the image should be replaced by your own appKey and appToken. {"base64":"  ","img":{"width":1506,"height":730,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":75357,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/getting-started-making-your-first-request-0.png"}}

See below the expected response in our apiexamples store: {"base64":"  ","img":{"width":1034,"height":493,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":45915,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/getting-started-making-your-first-request-1.png"}}

If you get a 401 - Unauthorized as response, review the authentication steps. Make sure that the right permissions are defined in the roles and that you copied the exact appKey and appToken values into the headers of the request.

If you received a 200 OK response, congratulations on your first successful request to VTEX APIs! 🎉

Using Postman

Our API reference documentation is built using the Open API 3.0 (OAS 3.0) standard. The OAS 3.0 schemas are available for download in our GitHub repository.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAACCAIAAADwyuo0AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAJUlEQVR4nAEaAOX/AL/CxqWkp5ijlmR9ZgDw8fLHyc0eOFAADi3Iig1hSDezrQAAAABJRU5ErkJggg==","img":{"src":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/getting-started-making-your-first-request-2.png","width":433,"height":214,"type":"png"}}

You can import our API endpoints to Postman by downloading the JSON schemas you are interested in and following these instructions.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page