Using Postman for REST API calls
Postman is one of the most commonly-used and simplest way to make REST API calls. It is also free to use (for limited usage). You can download Postman here: https://www.postman.com/downloads/ .
Here are very simple and shortened instructions for how to use Postman for creating REST API calls. For more in-depth documentation, please refer to Postman's own documentation: https://learning.postman.com/docs/getting-started/introduction/. Please note that support for using Postman is not included in Proximi.io support.
Start your first request by creating a new HTTP request:
From there we need to continue by authorising Postman to point your request to your Proximi.io account. In order to do so, paste your token to Postman from Proximi.io Portal, token can be found from Applications. Note that there are two kinds of tokens under your account: mobile and master. With mobile token you can do GET requests. For other kinds of requests you need to use the master token.
Once you have copied it, please navigate yourself to Headers in Postman and type Authorization as ‘Key’. Type Bearer and paste your token as ‘Value’. Please see the picture below for demonstration.
After you have completed the authorization we can move on to create our first request. All the available requests and methods can be viewed from our REST API documentation.
Let’s start from GET request. As GET already indicates you, it will provide you information as a response. If you want to view e.g. all geofences from your account, please choose GET as a method and type URL on the dedicated field for it. In this case the URL would be https://api.proximi.fi/core/geofences. Click "Send".
After sending the request, the result should be visible for you in the Body tab. By default, the response is visible in JSON format but if you prefer to view it in other format, please choose your preferred one from the button on the top (JSON). Please see the picture below.
Besides to GET, you can use e.g. POST, PUT and DELETE in order to add, update and delete something from your Proximi.io account.
The recommended way of proceeding for beginners is to extract the content you want to edit with a GET request, edit is as preferred with a code editor of your choice (even Notepad works), and then POST the result back.
With POST requests you must use format= raw / JSON.
Paste the content you want to send in here:
Send the request as previously.