JPlug API Reference

    v1.0.0 · https://api.jplug.io/api

    Introduction

    The JPlug API gives you full programmatic control over your EV charging infrastructure — register chargers, manage driver auth codes, start and stop sessions, configure billing, and deploy white-label themes.

    Base URL
    https://api.jplug.io/api
    ProtocolHTTPS · REST · JSON
    API Versionv1
    AuthAPI Key (X-API-Key header)
    SpecOpenAPI 3.0.3

    Authentication

    All API requests must include your API key in the X-API-Key header. You can generate keys from the JPlug dashboard under Settings → API Keys, or via the Create API key endpoint.

    Example request with auth
    curl https://api.jplug.io/api/v1/chargeboxes \
  -H "X-API-Key: jplug_live_xxxxxxxxxxxxxxxxxxxx"

    Keep your key secure. API keys carry full account access. Don't commit them to source control or expose them in client-side code. Revoke and rotate any key you suspect has been compromised.

    ⚡

    Charge Boxes

    5 endpoints

    Core resource representing a physical OCPP charge point connected to JPlug. Create, update, query, and remove chargers from your network.

    🔄

    Transactions

    4 endpoints

    Charging sessions. Start and stop sessions remotely, and query historical transaction data including energy consumed.

    🏷️

    Auth Codes

    5 endpoints

    ID tags (RFID cards or app-generated codes) used to authorize drivers before starting a charging session.

    💳

    Billing Models

    5 endpoints

    Define how drivers are billed for charging sessions — flat fee, per-kWh, per-minute, or tiered pricing rules.

    🎨

    Themes

    5 endpoints

    White-label branding configuration. Each theme defines a custom domain, color palette, and logo for an organization's driver-facing app.

    🏢

    Organizations

    3 endpoints

    Multi-tenant namespaces. Each organization gets its own domain, branding, and isolated charge box data — ideal for white-label deployments.

    🔑

    API Keys

    3 endpoints

    Manage programmatic access credentials. Each key carries a role that scopes its permissions across the API.

    📄

    Invoices

    3 endpoints

    View platform billing records. Invoices represent monthly subscription charges for your active charger and integration slots.

    📍

    Tax Jurisdictions

    1 endpoints

    Read-only list of supported tax regions. Use jurisdiction IDs when configuring billing models for region-specific tax rules.

    🔍

    Debug

    1 endpoints

    Inspect authenticated request metadata. Useful for verifying your API key is configured correctly.