JPlug API Reference

    Manager v1.0.0 / 36 operations

    OpenAPI specGet API Key

    Developer documentation

    Build with the JPlug API

    Register chargers, manage driver authorization, control charging sessions, configure billing, and create branded charging experiences with the Manager API.

    Production base URL

    https://api.jplug.io/api
    HTTPS / RESTAPI key authenticationOpenAPI 3.0.311 resources

    What’s new in this reference

    Updated
    New endpoint

    Theme asset uploads

    Upload PNG or JPEG images to four branding slots. Maximum file size: 2 MiB.

    Expanded documentation

    Organization-owned themes

    Full configuration for language, support links, social previews, and light and dark design tokens.

    Charger configuration

    Address, custom metadata, and maximum power in watts. Charger creation requires an owned billing model.

    Filters and precise examples

    Transaction and theme filters, additional charger filters, and updated request fields and response codes.

    Field names use the exact capitalization from the specification. Starting a transaction returns 200 with TransactionID. See each operation for its required fields.

    Authentication

    Include your API key in the X-API-Key header on every request. To obtain access, contact JPlug. With an existing key, use Create API key to create another key.

    Authenticated request
    curl "https://api.jplug.io/api/v1/chargeboxes" \
  -H "X-API-Key: <your-api-key>"

    Keep API keys on your server and out of browser code and source control. Resource access follows the authenticated user’s permissions; theme operations require organization ownership.

    Most payloads use JSON. Theme image uploads use multipart/form-data, and the debug endpoint returns text/plain. Examples below are reference snippets and do not send API requests.

    Charge Boxes

    5 operations

    Register and manage charge points, assign billing models, and configure address, metadata, and maximum charging power.

    Transactions

    4 operations

    Start and stop charging sessions, retrieve transactions, and filter session history.

    Auth Codes

    5 operations

    Create and manage ID tags used to authorize charging sessions.

    Billing Models

    5 operations

    Create, retrieve, update, and delete billing models for your charge boxes.

    Themes

    5 operations

    Configure branding for organizations you own, including language, support links, images, and light and dark design tokens.

    Theme Assets

    1 operation

    Upload logos, favicons, and social preview images for a theme you own.

    Organizations

    3 operations

    Create organizations and retrieve those available to your account.

    API Keys

    3 operations

    List, create, and revoke API keys associated with your account.

    Invoices

    3 operations

    Retrieve invoices and totals grouped by invoice type. Listing supports metadata[key] filters; the spec does not enumerate all filter parameters.

    Tax Jurisdictions

    1 operation

    Retrieve the list of tax jurisdictions.

    Debug

    1 operation

    Inspect plaintext diagnostic output for an authenticated request.