Skip to main content

Postman

Postman is a very useful tool that allows you to test the API. It will allow you to play with the server (local or live) without having written any code. It provides an easy-to-use interface with advanced functionnality like authenfication helpers and environment variable.

As you need an account, its use is not mandatory. However, it is strongly recommended as it is a tool that is widely used in the professional world and useful for understanding the project API.

How to use

You can use it directly from your browser or you can download the application. However you cannot test websockets within your browser.

Set up the collection

You can fork the public E/Place collection and import it into your account. It is prefilled so you do not have to create request manually. It allows you test how the server behave with requests.

You can follow this guide to help you : Setup Postman

info

Make sure to read the Authentication section of the subject before using Postman as most of the requests will require you to be authenticated.