Getting Started

Get started with the Yipii IoT API integration

This guide will help you integrate with the Yipii IoT API. By the end of this guide, you'll be able to authenticate with the API and make your first request.

Prerequisites

Before you begin, ensure you have:

• A Yipii IoT account (sign up at iot.yipii.io)
• API credentials (OAuth2 client ID and secret)
• Basic familiarity with REST APIs

Step 1: Obtain API Credentials

1. Log in to your Yipii IoT dashboard at iot.yipii.io
2. Click your profile avatar in the top-right corner and select API Access
3. Click Create API Key
4. Give your key a descriptive name (e.g., "Fleet Integration")
5. Copy and save your API key securely

Step 2: Authenticate

The Yipii IoT API uses OAuth2 with the Client Credentials flow. See the Authentication Guide for detailed instructions.

Quick example using cURL:

curl -X POST "https://api.yipii.io/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Response:

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
  "token_type": "Bearer",
  "expires_in": 31536000
}

Step 3: Find Your Account Key

All API requests are scoped to your account using an account key. Find it in your dashboard URL:

https://iot.yipii.io/{ACCOUNT_KEY}/operations

Or fetch it via the API after authentication:

curl -X GET "https://api.yipii.io/api/v1/user" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Step 4: Make Your First Request

Once authenticated, you can fetch your assets:

curl -X GET "https://api.yipii.io/api/{ACCOUNT_KEY}/asset" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Response:

{
  "data": [
    {
      "id": 123,
      "name": "Delivery Van 1",
      "registration": "ABC-123",
      "tracker": {
        "id": 456,
        "imei": "123456789012345",
        "online": true
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 25
  }
}

API Base URL

All API requests should be made to:

https://api.yipii.io/api/{account_key}/

Replace {account_key} with your account identifier.

Rate Limits

The API enforces rate limits to ensure fair usage:

Rate limit headers are included in all responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1609459200

Next Steps

• Authentication Guide - Detailed OAuth2 setup with code examples
• Quick Start Examples - Common API usage patterns
• IoT-BE API Reference - Full API documentation