Skip to main contentSkip to search
Skip to main content

REST API

Key Takeaways
  • The IronWiFi REST API provides full programmatic control over user management, voucher generation, network configuration, and analytics -- enabling integration with HR systems, billing platforms, building access controls, and visitor management workflows.
  • All API requests use HTTPS with Bearer token authentication (
    Authorization: Bearer YOUR_API_KEY
    ) and JSON payloads.
  • Regional API endpoints are available in US East, US West, and Europe for lower latency.
  • The API supports 100 requests per minute per key, with bulk operations counting as single requests. Contact support for higher limits.
  • Common integrations include automated employee onboarding/offboarding, hotel PMS guest WiFi provisioning, and building access control synchronization.

IronWiFi REST API enables programmatic access to your WiFi network infrastructure. Automate user management, generate access vouchers, retrieve usage analytics, and seamlessly integrate IronWiFi with your existing HR, billing, building access, and visitor management systems.

Overview​

The API allows you to:

info

Full API documentation with interactive examples is available at api.ironwifi.com

Base URL​

The primary API endpoint is:

https://console.ironwifi.com/api

Regional endpoints for lower latency:

  • US East: 
    https://us-east1.ironwifi.com/api
  • US West: 
    https://us-west1.ironwifi.com/api
  • Europe: 
    https://europe-west2.ironwifi.com/api

Authentication​

All requests require an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

See Authentication for details on generating API keys.

Request Format​

  • Use HTTPS for all requests
  • Send JSON payloads with 
    Content-Type: application/json
  • UTF-8 encoding required

Example: List Users​

Example: Create User​

Example: Set User Password​

Common Use Cases​

Organizations use the IronWiFi API to automate WiFi access management across a wide range of workflows. The following are the most common integration patterns based on real-world deployments:

Building Access Control​

Automatically enable/disable WiFi access based on building access events. When a badge scan grants physical access, your building management system calls the IronWiFi API to activate the user's WiFi account in real time.

Human Resources​

Create user accounts when employees are onboarded, disable them when they leave. HR platforms like BambooHR, Workday, or SAP SuccessFactors can trigger API calls via webhooks to keep WiFi access synchronized with employment status.

Visitor Management​

Generate time-limited access codes for visitors from your check-in system. When a visitor registers at the front desk, the visitor management system (Envoy, Proxyclick, SwipedOn) creates a temporary IronWiFi account or voucher with a defined expiration.

Billing Systems​

Create users and manage access tiers based on subscription status. Service providers use the API to upgrade or downgrade bandwidth tiers when customers change plans.

Hotel PMS​

Integrate with property management systems (Opera, Mews, Cloudbeds) for automated guest WiFi provisioning. When a guest checks in, the PMS creates an IronWiFi account with the correct access duration and bandwidth tier.

Rate Limits​

  • 100 requests per minute per API key
  • Bulk operations count as single requests
  • Contact support for higher limits

Error Handling​

API errors return JSON with error details:

Common HTTP status codes:

  • 200
    - Success
  • 201
    - Created
  • 400
    - Bad request
  • 401
    - Unauthorized
  • 404
    - Not found
  • 429
    - Rate limited
  • 500
    - Server error

Next Steps​

Frequently Asked Questions​

Q: Where do I find my API key?​

Generate an API key in the IronWiFi Console under Account > API Keys. See API Authentication for detailed instructions. Keep your API key secure and never expose it in client-side code or public repositories.

Q: What is the API rate limit?​

The default rate limit is 100 requests per minute per API key. Bulk operations count as single requests. If you need higher limits for high-volume integrations, contact IronWiFi support to request an increase.

Q: Can I use the API to generate vouchers automatically?​

Yes. Use the voucher endpoints to programmatically create individual or batch vouchers with custom validity periods, usage limits, and bandwidth settings. This is commonly used to integrate with hotel property management systems (PMS) or event registration platforms.

Q: Is the API available in all regions?​

Yes. The primary endpoint (

https://console.ironwifi.com/api
) works globally. For lower latency, use regional endpoints: US East (
us-east1.ironwifi.com/api
), US West (
us-west1.ironwifi.com/api
), or Europe (
europe-west2.ironwifi.com/api
).

Was this page helpful?