Getting Started

Base URL

Throughout this documentation, [[BaseUrl]] refers to the base URL of your environment.

ENGAGEMENT Environment

https://api.iperawifi.com/api/v1

MIDDLE EAST Environment

https://api.me.iperawifi.com/api/v1

Postman Collection

Download the ready-to-use Postman collection for all V1 endpoints. Import it into Postman, set the baseUrl and api_token variables, and start making requests immediately.

After importing:

1. Open the collection in Postman
2. Go to Variables tab
3. Set baseUrl to your environment URL (e.g. https://api.iperawifi.com/api/v1)
4. Set api_token to your Bearer token

Authentication

All API requests must include a Bearer token in the Authorization header.

Authorization: Bearer <api_token>

API tokens are provided by IPERA. Keep your token secure and do not share it publicly.

Content Type

All requests and responses use JSON. Include the Content-Type header in every request.

Content-Type: application/json

Pagination

List endpoints return paginated results. Use the page and per_page query parameters to navigate through records.

Response Structure

Every list response wraps data in a data array and includes links and meta objects:

{
  "data": [...],
  "links": {
    "first": "[[BaseUrl]]/guests?page=1",
    "last": null,
    "prev": null,
    "next": "[[BaseUrl]]/guests?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "[[BaseUrl]]/guests",
    "per_page": 10,
    "to": 10
  }
}

Example

Fetch the second page of guests, 25 records at a time:

curl -X GET "[[BaseUrl]]/guests?page=2&per_page=25" \
  -H "Authorization: Bearer <api_token>" \
  -H "Content-Type: application/json"

To iterate through all pages, continue requesting links.next until it returns null.

Rate Limiting

Most endpoints are limited to 60 requests per minute. Endpoints with a different limit are noted individually in their documentation.

When you exceed the rate limit, the API returns:

Error Responses

The API uses standard HTTP status codes. Common error responses are listed below.

{
  "message": "Unauthenticated."
}

{
  "message": "This action is unauthorized."
}

{
  "error": "Record not found"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "field_name": [
      "Validation error message."
    ]
  }
}

Notes

• Date fields are returned in ISO 8601 format and in UTC timezone (e.g. 2024-01-21T11:41:39.000000Z).
• Date filter parameters use the format yyyy-mm-dd unless otherwise stated.
• Boolean parameters accept true or false as values.

Changelog