Welcome to the Hapn API Documentation
Learn about Hapn, the Hapn API, and how it can help you build location-based applications and automations. Here you'll find documentation to help you start working with the Hapn API as quickly as possible, as well as support if you get stuck.
What's Hapn?
Hapn is a cloud platform that enables small, medium, and large businesses to monitor and track their assets around the world. Messages flow from Hapn devices to the cloud platform using the most advanced connectivity providers. Data is processed instantly to generate alerts, notifications, and status updates in near real-time.
Why Hapn?
Ultra Reliability
- The most reliable GPS tracker platform, boasting a 99.998% uptime. It is always up and running when you need it the most.
- No message left behind. Messages are stored and processed in parallel, simultaneously. In the unlikely event of a bottleneck in handling traffic, all data is captured and no message is ever lost. Raw data that cannot be delivered due to connectivity issues is securely stored in the device and transmitted at a later time.
- Redundant Multi-Region availability ensures that, in case of an infrastructure failure in one region, replicas in other regions will take over automatically without any customer impact.
Premium Connectivity
- Most reliable networks. We partner with the most advanced providers to access the best wireless networks in the US and globally. This allows our devices to send data quickly and reliably.
- Multi-network access. All of our devices are equipped with multi-network SIM cards that automatically connect to the fastest available networks in a given area to optimize coverage and speed.
- Global coverage. Hapn operates using the most comprehensive list of Tier 1 networks. Our devices have access to nearly 400 cellular networks around the world, supporting 2G (GSM/GPRS), 3G (UMTS/CDMA2000), 4G (LTE), and LTE-M connections.
Extreme Speed
- Top network Efficiency. Hapn devices communicate with our cloud platform via UDP instead of TCP. This allows for faster data transmission without delays or extended latency time. UDP is also more efficient in terms of bandwidth, and less impactful on the device battery life.
- Low Latency. Rather than measuring speed in minutes or hours, which can make alerts and updates meaningless, we track pipeline latency in milliseconds. Location updates from Hapn devices, with ideal connectivity, can be available to users under 2 seconds on average.
- Inline Alert Processing. Whereas traditional platforms do not start generating alerts until messages have been stored, Hapn is designed to prioritize alert delivery. This means that alerts are generated immediately as soon as a relevant event is processed. Any slowdown in I/O operations caused by a spike in traffic, doesn't cause delays in alerts and position updates.
What's Hapn API?
The Hapn API consists of a collection of HTTP endpoints for interacting with devices and platform data. These endpoints include device messages, alerts, and insights. Additionally, the API allows users to subscribe to events via webhooks, which can be managed programmatically.
Using the Hapn API, users can leverage the power of low-latency message processing and device programmability, on par with the functionality of the Hapn applications.
How to access the API
All URLs in the Hapn API documentation use the following base URL: https://api.iotgps.io/v1
Data is served over HTTPS to ensure the highest level of privacy. Unencrypted HTTP is not supported. The API responses are provided in JSON format.
Using Postman
The Hapn API can be accessed using a public Postman collection here: Hapn API Postman Collection
Setting up the credentials
Before using the Hapn API in Postman, you need to configure your clientId and clientSecret (provided by Hapn). Make sure you follow these steps:
1- Sign In using a Postman account.
2- Open the Production environment and enter the cliendId and clientSecret values in the Current Value column.
3- Open the Collections/Hapn API/Authorization space, change the environment to Production, and click on “Get New Access Token” button.
4- Then you can navigate to any of the API request examples, and the recently generated token will be used as the authorization token.
cliendId and the clientSecret then the Current Value field of those values will be only available to you.