Skip to main content

Admin API Introduction

The myDevices Admin API enables White Label customers to programmatically access and manage their IoT platform data. Whether you're building a billing integration, monitoring dashboard, or custom management tool, the Admin API provides the foundation for your integration.

Note: The Admin API is available exclusively for White Label customers.

What Can You Do with the Admin API?​

The Admin API gives you comprehensive access to your white label application data:

  • Companies & Locations - Query organizational hierarchy and customer accounts
  • Devices - Monitor device status, retrieve sensor readings, and manage device lifecycle
  • Users - Manage user accounts, permissions, and authentication
  • Rules & Alerts - Access alert configurations and notification history
  • Assets - Track and manage asset information

🚀 Get Started

New to the API? Start here for authentication and your first API call.

Quick Start Guide →

🔐 Authentication

Learn about admin-level and user-level authentication.

Authentication Guide →

📖 API Reference

Complete endpoint documentation with examples.

API Reference →

Common Use Cases​

Billing System Integration​

Query companies, locations, users, and device counts to integrate with your billing system. The Admin API provides all the data needed to calculate usage and generate invoices.

Example: Get all companies → Count devices per company → Generate billing report

See Companies API →

Multi-Tenant Monitoring​

Monitor device health, connectivity, and sensor readings across all your customers from a centralized dashboard.

Example: Query all devices → Filter by status → Alert on offline devices

See Devices API →

Customer Analytics​

Generate reports on user engagement, device adoption, and platform usage across your entire white label application.

Example: Get user list → Query device counts → Analyze growth trends

See Users API →

Automated Provisioning​

Programmatically create users, assign locations, and provision devices as part of your onboarding workflow.

Example: Create company → Add user → Provision devices → Set permissions

See Get Started Guide →

API Architecture​

The myDevices platform is built on a microservices architecture, providing high availability, performance, and reliability. The API is organized into logical service groups:

  • Admin Services (/v1.0/admin/*) - Cross-user operations and white label management
  • User Services (other routes) - User-specific data and operations
  • Authentication Services - OAuth2 token management

All API endpoints use HTTPS for secure communication and require OAuth2 authentication.

Getting Your API Credentials​

Before you can use the Admin API, you need to obtain your unique API credentials:

  1. Log into your account on the myDevices console
  2. Select Admin API from the menu
  3. Navigate to the API section
  4. Click Show to reveal your Client Secret
  5. Save the following credentials:
    • Realm
    • Client ID
    • Client Secret

API Credentials Screenshot

Keep Your Credentials Secure

Never commit your Client Secret to version control or expose it in client-side code. Store credentials in environment variables or secure credential management systems.

Next Steps​

Ready to start building? Here's your roadmap:

  1. Get Started Guide - Authenticate and make your first API call
  2. Authentication Overview - Understand admin vs user authentication
  3. API Reference - Explore all available endpoints
  4. Example Applications - Review sample code on GitHub

Support & Resources​

Ready to dive in? Continue to the Get Started Guide to authenticate and make your first API call.