Writing an API call from scratch can be difficult if you do not know how to code. In this tutorial, we'll show you how to use Postman to write and send your API calls.
Downloading and Installing Postman
Visit the Postman website and click on the button that says "Download the App".
Download the version of Postman that is compatible with your operating system, and then install it as you would any other application.
Using Postman to write ParseHub API calls
1. To begin writing a new API call in Postman, open the Postman app and click on the "Request" option.
2. Name your Request, choose a folder to save it in, and then click on the "Save" button at the bottom of the pop-up window.
3. Begin writing your API call. You can refer to our API Documentation to find the different methods you can use and what you can use them for. For this example, we are going to show you how to run a project using our API.
According to our documentation, running a project uses the POST method, so choose this method from the method dropdown menu in Postman.
You can then copy and paste the HTTP request for the method into the "Enter request URL" field in Postman (excluding the method already chosen in the step above).
Be sure to replace the {PROJECT_TOKEN} and/or {RUN_TOKEN} section(s) with the values from your own project.
4. In order to specify the parameters for your API call, you will need to put them in the body of your call. Click on the "Body" tab underneath the "Enter request URL" input bar, and then type in your parameters. The API key is the only required parameter needed to send a call to our API in this case, but you can enter any other parameters that you want to include in your call in subsequent lines in the Body.
5. Now that your API call is completed, click on the "Send" button to send your call to our API. If done correctly, you'll get a response from our API containing more information about your call.