How to use Postman for Magento GraphQL APIs?

In this blog, we are going to see how we can use Postman for GraphQL APIs. And we will learn this by implementing a complete checkout process on a Magento eCommerce website. Before moving forward, let's see what is GraphQL.

What is GraphQL?

GraphQL is a data query language developed internally by Facebook in 2012 before being publicly released in 2015. Magento implements GraphQL to provide an alternative to REST and SOAP web APIs for front-end development.

How to access Magento's GraphQL APIs?

You can use any GraphQL IDE like GraphiQL or Postman. Or you can install chrome extensions (GraphiQL extension) for accessing GraphQL APIs. Among all the above options we are going to learn how to access GraphQL using Postman.

How to use Postman for GraphQL APIs?

Let's start learning a fresh tab in Postman. Once you install postman, you will be able to see as below screenshot. 

 

Now please follow the below steps to use GraphQL in Postman.

• Get the GraphQL endpoint. For example, if you have a website with a domain like: example.com then your endpoint will be http://example.com/graphql.
• Select Post from the dropdown on the left side of the endpoint input box.
• Then select the Body tab shown below the endpoint input box. Then select the GraphQL radio button.
• Insert your GraphQL query/mutation inside the query box.

By following the above steps, you can access all your GraphQL APIs which don't need authorizations. But if you want to execute APIs which need authorization then follow the below steps to add authorization.

• Go to the Authorization tab shown below the endpoint input box.
• Select the Bearer Token type from the dropdown. Enter the customer's token inside the token input box.

After this, you can access all the GraphQL APIs from postman.

Refer here to get the complete list of queries & mutations that Magento provides. And to get a tutorial for the complete checkout process of logged-in customers & guest customers refer to this documentation.

Thought: I have used postman because it's very easy to manage the APIs. We can create a collection and use it in the future or share it with teammates and create a document to share with others.