Get started in 5 easy steps

It is best to start with the simplest scenario, to get a hold of the basics. Let’s start with a simple GPS geofence that triggers a push notification on enter event.

Step 1. Dashboard

Register yourself an account and login at: https://portal.proximi.io/. Use a laptop or desktop computer for the setup, not your mobile device.

Proximi.io Web Portal is the heart of the whole platform. It’s used to configure all the aspects of the whole proximity setup. The Dashboard shows you the overall status of your projects.

Step 2. Geofences

Add a geofence around your current physical location. You can do that under “Manage geofences” -> “Add geofence”.

Geofences are used to define physical areas that you want to use in your application. With Proximi.io platform, all technologies indoors and outdoors function with the same logic. In addition to the standard GPS geofences, you will be using them with beacons, geomagnetic positioning, and all other potential positioning technologies.

You only need to define a name and address, and the latitude and longitude will be defined automatically. Radius is the size of the geofence in metres. Make your geofence large to start with, e.g. 100. Click next to move your geofence on top of the map view to the correct position and size.

Step 3. Action flow

Add your first action flow under “Actions” in the left-hand menu.

When one of your app’s users enters a geofence, that triggers an enter event. Action flows are a way to define what should happen on enter or exit events. An action flow can include a simple push notification, but it can also be used for visitor counting, turning on lights or showing them a targeted advertisement on a digital screen.

The action flows are based on NodeRED. If you are familiar with that, you’ll know what to do. Just drag-and-drop the nodes you will need to the canvas in the right order.

To speed up our testing, we can cheat a bit. Just copy the code below, and paste it through the menu on top-right corner -> Import -> Clipboard. Click deploy to save it.

[{"id":"c8a5de91.3743","type":"proximiio-event-receiver","z":"c2107610.bc4918","delete_event":true,"x":150,"y":82,"wires":[["b716d6b5.826ff8","ccb60590.2c4778"],[]]},{"id":"35cac499.23ef5c","type":"function","z":"c2107610.bc4918","name":"Example push notification","func":"return {\n type: 'push',\n title: 'Welcome to the demo!',\n _proximi_id: msg._proximi_id,\n _proximi_visitor_id: msg._proximi_visitor_id\n}","outputs":1,"noerr":0,"x":531,"y":188,"wires":[["b1b73fba.bf8c2"]]},{"id":"b1b73fba.bf8c2","type":"proximiio-event-transmitter","z":"c2107610.bc4918","x":807,"y":237,"wires":[]},{"id":"ccb60590.2c4778","type":"debug","z":"c2107610.bc4918","name":"Debug the event","active":true,"console":"false","complete":"true","x":419,"y":73,"wires":[]},{"id":"b716d6b5.826ff8","type":"switch","z":"c2107610.bc4918","name":"Check the event type","property":"event","propertyType":"msg","rules":[{"t":"eq","v":"enter","vt":"str"},{"t":"eq","v":"exit","vt":"str"}],"checkall":"false","outputs":2,"x":207,"y":157,"wires":[["35cac499.23ef5c"],[]]}]

Step 4. Testing

Test it out in real life. Best way to do your initial tests is with our Android and iOS Management Apps. Just login with the same credentials you logged in to the portal with. You should see the app finding your position and showing you your demo push notification.

appstore_small   playstore_small

Step 5. Building your own app

Now that you have gotten an idea about how the platform works, you can either dive deeper into the Proximi.io features, or start integrating to your own app.

To integrate to your own app

Note: You’ll find your auth token on the portal under “Manage Application”.