Connect Yipii to your existing tools
Four ways to get Yipii data anywhere
Pick the approach that fits your team's tooling and engineering comfort. Two of these need a developer for an afternoon. Two of them need nobody.
REST API
Assets, positions, history, reports and tracking links over HTTPS. One base URL scoped by your account key, a bearer token in the header.
Live position stream
A socket carrying every asset you subscribe to. Positions arrive as the trackers send them, so nothing has to poll for a vehicle that has not moved.
Reporting service
A separate service that queues a report, runs it on background workers and hands back a download link. 15+ report types in JSON, PDF, Excel or HTML.
Webhooks and Zapier
Events pushed to your own endpoint, or into Zapier when nobody on the job wants to build anything.
Four calls from an empty screen to a live position stream
You need a Yipii IoT account, the assets you want to read, and a role that can reach Settings. Everything after that is four requests, in this order.
Create an API key
Open the API Access tab in Yipii IoT and name the key after the thing you are deploying, because that name is all you will have to recognise it by later. Copy it there and then. The key is shown once and only a hash is stored.
Read your account key
One call to the user accounts endpoint returns the account slug. Every URL after this is scoped by it, which is also how the API keeps one tenant out of another.
List the assets
The asset map endpoint returns the vehicles and equipment that key can see, with their ids and metadata. The stream is keyed on that id. An IMEI or a number plate will not work.
Open the socket
One connection per account, carrying the access token and the asset ids you want. The first message is an array of last known positions, then updates arrive one at a time.
The request bodies, the sample responses and the troubleshooting list are written out in the integrator setup guide.
Assets, positions and history over HTTPS
Requests go to api.yipii.io, scoped by your account key, with a bearer token in the Authorization header. List the assets on an account, read the current location of one, pull its history between two dates, or create a public tracking link for a customer waiting on a delivery. Authenticate with an API key from the API Access tab, or with OAuth2 client credentials if you would rather issue tokens from your own service.
- List every vehicle and asset on the account, paginated
- Current location with latitude, longitude, speed, heading and altitude
- Location history between a start and an end date
- Create a public tracking link with its own expiry
- API keys or OAuth2 client credentials, both sent as bearer tokens
- Revoke a key from the same screen, immediately and for good
The developer API comes with Yipii Max, which we price with you rather than publish. Calls and connection hours are metered with an allowance included, and heavier usage or the detailed data tier is quoted against what you are building. See what each plan includes
One socket per account, every asset on it
Yipii streams positions over socket.io. You open a single connection carrying the asset ids you care about, and the first location message arrives as an array of last known positions before individual updates start. Opening one socket per vehicle gets you throttled or refused, so batch the list instead. Trackers report every 10 to 30 seconds while a vehicle is moving, every 60 seconds when it is stopped with the ignition on, and every 5 to 10 minutes once it is switched off.
- Access token and asset ids on the handshake, token checked on every connect
- Channels for location, alerts, vehicle health and driver behaviour
- Order and de-duplicate on wsSeq, a monotonic counter, never on the timestamp
- Asset ids are filtered against the account before any data flows
What slim gives you, and what detailed adds
Every stream starts on slim. It is enough to draw vehicles on a map and log trips. Detailed is the paid upgrade, and it changes both what arrives in each frame and how often frames arrive at all.
Slim, the default
- Ten fields a frame: position, speed, course, timestamps and a status label.
- Trip start and stop, with distance and fuel figures.
- Throttled to one frame per asset per 25 seconds, however fast the tracker reports.
- No reverse-geocoded addresses and no alerts on the socket.
Detailed, the paid tier
- The throttle comes off, so frames land as the tracker sends them.
- Street addresses instead of raw coordinates, and a payload roughly ten times the size.
- Speed, idle, geofence and temperature alerts on the socket, plus power-cut detection.
- Beacon and sensor readings. Vehicle health needs a Mobility plan, and driver identity and behaviour scoring need the driver add-on.
Switching is sales-managed: you ask from the API Access tab, we approve it, and the stream changes without a client-side change on your side. Detailed carries terms worth reading before you design around it, including a "Powered by Yipii IoT" attribution, no public exposure of the data without a written agreement, and no resale. The field-by-field comparison is in the AVL data tiers reference.
Reports are queued, then handed back as a file
The reporting service runs on its own host, separate from the IoT API, and it works asynchronously. You post a request and get back a report id with an estimated completion time, then listen on its socket for queued, processing and completed events. The completed event carries a pre-signed download URL good for an hour. Where your environment cannot hold a socket open, poll the status endpoint every three seconds instead.
- 15+ report types across trails, trips, driver behaviour, fuel, beacons and mileage
- JSON, PDF, Excel and HTML output
- Date ranges from 14 days on OBD data up to 365 on monthly mileage
- The same OAuth2 bearer token as the IoT API
See what each integrator is consuming
When third-party developers are working on your account, the developer dashboard meters them. API calls and AVL connection hours are counted separately, each against its own quota, with the days left in the billing window beside them. The summary card turns amber at 80% of quota and red at 100%. Only users flagged as integrators are metered, so your own staff clicking around the dashboard never counts against the number.
- Hourly API call trend across the last 24 hours
- Integrators table with calls, AVL hours and last activity per person
- Free and Pro tiers, tracked separately for each of the two meters
- Admins see everything, fleet managers view only, other roles not at all
Events pushed to you as they happen
Most fleet events fire a webhook: geofence entry and exit, speed thresholds, temperature breaches, a device going offline, a work order completed, an inspection result, a document about to expire. Point them at your own endpoint, or at Zapier if you would rather wire Yipii to accounting and messaging tools without writing anything. The same rules can send an email, a WhatsApp message or an SMS when the recipient is a person on a phone.
- Webhooks to any HTTPS endpoint you control
- Zapier for the thousands of apps you would otherwise integrate one by one
- WhatsApp for the alerts somebody has to act on now
- Email free and unlimited, WhatsApp and SMS at 1 to 3 credits a message
What the API will not do for you
Slim positions are throttled
On the default tier the stream sends at most one frame per asset per 25 seconds, however often the tracker reports underneath. If you are building something where a vehicle has to move smoothly across a customer's screen, that is the detailed tier, and the detailed tier is paid. Better to know before you build the map than after.
IoT keys carry no scopes
A Yipii IoT key inherits whatever the account behind it can reach. There is no read-only key and no per-endpoint permission, so treat every key as full access and revoke it the day a contractor finishes.
Yipii Mobility keys work differently: they take optional abilities such as read-assets or write-work-orders, plus an optional expiry date. Revocation in either app is immediate and cannot be undone.
Reports are not posted to a webhook
The reporting service tells you a file is ready over its socket, or you poll the status endpoint every three seconds. There is no callback URL to register. Three reports per user run at once, a queued job gives up after ten minutes, and a download link expires an hour after it is issued, so fetch the file while the link is live.
Hitting the quota stops calls
Past quota, API calls come back as 402 Payment Required and new stream connections are refused. People working inside the dashboard carry on unaffected, which means the first sign of trouble is usually an integrator's overnight job failing rather than anyone noticing in the app. Watch the amber marker at 80%.
Frequently asked
Yes. It covers assets, current location, location history, reports and public tracking links, plus the API keys themselves, at api.yipii.io with every path scoped by your account key. Authenticate with an API key created in the API Access tab, or with OAuth2 client credentials if you would rather issue tokens from your own service. The full endpoint list and the developer guides are public at docs.yipii.com.
Most fleet events: geofence entry and exit, speed thresholds, temperature breaches, a device going offline or coming back, work order status changes, inspection completion and document expiry. Point them at any HTTPS endpoint you control, or at Zapier. The rule builder that decides which event goes where is Automations, and the same rules can send an email or a WhatsApp message instead of a callback.
Yes. Yipii events flow into Zapier, which connects them to thousands of apps without any code from you. The usual three are pushing trip data into billing, sending inspection outcomes to a safety tool, and routing alerts into team chat. If you have a developer on hand, a webhook straight to your own endpoint is faster and cheaper than going through Zapier.
Yes, over a socket.io stream instead of polling the REST API. You open one connection per account carrying the asset ids you want, and positions arrive as the trackers report them: every 10 to 30 seconds while a vehicle is moving, every 60 seconds stopped with the ignition on, every 5 to 10 minutes once it is switched off. On the default slim tier the stream is throttled to one frame per asset per 25 seconds. The paid detailed tier takes the throttle off and adds addresses, alerts and sensor data. There is a browser demo in the docs that runs the whole handshake on mocked data before you write anything.
There is a separate reporting service at reporting.yipii.io with its own socket for progress events, and it runs asynchronously. You post a request, it queues, and a completed event hands back a pre-signed download URL valid for one hour. 15+ report types cover trips, trails, driver behaviour, fuel, beacons and mileage, in JSON, PDF, Excel or HTML. Date ranges cap by report type, from 14 days on OBD data up to 365 days on monthly mileage, which is why long-range aggregates live here and not on the IoT API.
API access is an IoT add-on, and we quote it. There is no list price. API calls and AVL connection hours are metered separately, each with a free allowance before a paid tier, and the developer dashboard shows where you are against both. The detailed data tier is priced per vehicle per month on top of that. Webhooks are included. Email notifications are free and unlimited, while WhatsApp and SMS cost 1 to 3 credits a message depending on destination. Tell us what you are building and we will price it.
The rest of the picture
Start here
- Authentication, for the OAuth2 client credentials flow and the account key
- API keys, for creating, listing and revoking them
- Quick start, for the endpoints most integrations need on day one
Go deeper
- Live tracking and WebSocket, for the handshake, the payloads and the reconnection rules
- Developer dashboard, for quotas, tiers and per-integrator consumption
- IoT-BE API reference, for the full endpoint list