Getting Started with Phorest API

The Phorest API is an application programming interface, it’s a set of rules that lets a program talk to the Phorest Application, exposing Phorest data and functionality.

Note: You will need to contact support@phorest.com to get set up with API access. 

Testing the API - Step-by-step guide 

To Test the API you will need to install Postman.
https://www.postman.com/

You can find the Phorest Postman collection with all the endpoints here.
https://www.getpostman.com/collections/05a54ef99ac98dd4cbda
To import the Phorest API Collection into Postman go to File -> Import -> Import From Link tab.

The Phorest Postman Collection has a set of variables that you may want to configure.
To configure these variables click Edit on the API collection.

This will show a list of variables that can be set.
The most important ones to set are third-party-apibusiness and branch.

You can also set your username and password by right-clicking on the endpoints folder and selecting the Authorization tab.  The API requires Basic Authentication, this will be the API username and password supplied by Phorest.

Note: The username will always have the prefix `global/` e.g global/test@test.com.

To test the setup, open up the collection and click on the endpoints folder. 
Click Get branches and press Send.
The response will be a list of branches and the branch details.

Was this article helpful?
0 out of 0 found this helpful