Documentation: gethapn.readme.io
API base URL: https://api.iotgps.io/v1
Everything is served over HTTPS — plain HTTP is not supported — and responses come back as JSON.
What the API is
The Hapn API is a set of HTTPS endpoints for working with your devices and your platform data: device messages, positions, alerts and insights. You can also subscribe to events with webhooks and manage those subscriptions programmatically, rather than polling for changes.
It runs on the same pipeline that powers the Hapn apps, so what you get through the API is the same data, at the same speed, as what you see on the map.
What you can build with it
- Location and device data — real-time and historical positions, device status, battery levels and sensor readings.
- Device management — configuration and behaviour, including bulk operations for larger fleets.
- Places and geofences — boundary management with entry and exit events.
- Alerts — alert configuration and triggered event notifications.
- Trips and activity — trip analysis and usage insights.
- Users and accounts — account management with permission controls.
Typical uses: pushing tracking data into an existing rental or dispatch system, driving your own dashboards, or automating something that would otherwise be manual work in the app.
Getting access
Start in the app — the web app or the mobile app. Open Settings (web: in the left sidebar; mobile app: Menu → Settings) → API Credentials, under Advanced. If it's there, you can issue your own credentials without asking anyone:
- Select Create API Token (on the mobile app the button is just Create).
- Give the token a name — something that says what will be using it, so you can tell them apart later.
- Select Create.
- Copy the secret immediately. The panel warns you plainly: it is shown once, at creation, and never again. Lose it and you create a new token.
Existing tokens are listed with their name, who created them and when.
If API Credentials isn't in your Settings menu
The page isn't enabled on every account. If you don't see it under Advanced, API access isn't switched on for you yet — contact your account manager or Hapn support and ask for it. There's nothing you can turn on yourself to make it appear.
Ignore the client ID and client secret in the documentation
The API documentation still describes an older method, in which Customer Success issued you a client ID and client secret to exchange for a token. That has been replaced by the API tokens above. Create a token in the app and use it. If you are part-way through an integration built against that guide, switch to a token from Settings → API Credentials.
AEMP: a different thing worth not confusing
In Settings → API Credentials — the same page, and subject to the same account gating — you'll also find AEMP tokens. AEMP (ISO 15143-3) is the standard telematics feed for construction and heavy equipment — it's how you hand your fleet's data to a customer, an OEM or a third-party system that speaks that standard. It is not the REST API described above, and you create one yourself rather than asking for it: Settings → API Credentials → Create AEMP Token (Create on the mobile app). The only thing you choose is an expiration date — it defaults to one year from today — and the token is generated for you. Existing tokens are listed with who created them, when, and when they expire, which is worth checking before one lapses and a customer's feed goes quiet. See Connecting an OEM Telematics Provider to Hapn for the other direction — pulling a manufacturer's data into Hapn.
Getting help
- The documentation at gethapn.readme.io is the reference for endpoints, authentication and payload formats.
- Your account manager, if you have a dedicated one.
- Support at support@gethapn.com, or submit a ticket. Our team can help with authentication problems, endpoint questions and data formatting.
When you get in touch about an API problem, include the endpoint you called, the time, and the response you got back — it turns a long thread into a short one.
Comments
0 comments
Article is closed for comments.