OCPP Authentication & Onboarding APIs

Summary

We've added a new set of endpoints to the Integrations API that let you commission Zaptec chargers onto your own OCPP 1.6J backend, and manage OCPP authentication settings, directly via API without needing to configure this manually in the Zaptec Portal or Zaptec App.

These endpoints use a separate base URL from the core Zaptec Web API. For now, the same access token works for both APIs.

Endpoints Added

Base url:

https://integrations.api.prod.zaptec.com

Charger Onboarding

POST /chargers/{chargerId}/onboarding

Charger Password Management

POST /chargers/{chargerId}/ocpp/settings/password

POST /chargers/{chargerId}/ocpp/settings/encodedauthorizationkey

Charger OCPP Configuration

PUT /chargers/{chargerId}/ocpp-settings

Installation Authentication Modes

PUT /installations/{installationId}/mode/ocpp

PUT /installations/{installationId}/mode/ocpp-cloud

PUT /installations/{installationId}/mode/zaptec

Overview

Zaptec now provides dedicated APIs for managing OCPP onboarding, authentication, and installation authentication modes.

These endpoints allow integrators to:

• Onboard chargers into OCPP mode
• Configure the OCPP Central System URL
• Manage OCPP passwords
• Supply pre-generated OCPP AuthorizationKeys
• Switch installations between Zaptec, OCPP, and OCPP Cloud authentication modes

The new APIs simplify charger provisioning while supporting both standard OCPP password handling and advanced deployments where AuthorizationKeys are generated externally.

What's New

Charger Onboarding

Endpoint

POST /chargers/{chargerId}/onboarding

This endpoint simplifies initial OCPP provisioning by combining multiple configuration steps into a single request.

The endpoint:

• Enables OCPP authentication mode for the charger
• Configures the OCPP Central System URL
• Optionally configures the ChargeBoxId

This is the recommended endpoint for onboarding new chargers.

Plain Password Support

Endpoint

POST /chargers/{chargerId}/ocpp/settings/password

This endpoint accepts a plain-text password.

Zaptec automatically converts the password into the hexadecimal OCPP AuthorizationKey required by the charger before forwarding it.

Use this endpoint when your backend stores passwords in plain text.

Encoded AuthorizationKey Support

Endpoint

POST /chargers/{chargerId}/ocpp/settings/encodedauthorizationkey

Some Charge Point Management Systems generate the AuthorizationKey themselves.

This endpoint allows sending an already encoded AuthorizationKey directly to the charger without any additional processing.

Use this endpoint only if your backend is responsible for generating the OCPP AuthorizationKey.

Installation Authentication Modes

Dedicated endpoints are now available for changing the authentication mode of an installation.

Enable OCPP Mode

PUT /installations/{installationId}/mode/ocpp

Enables standard OCPP authentication.

Required payload:

• ocppUrl

Enable OCPP Cloud Mode

PUT /installations/{installationId}/mode/ocpp-cloud

Enables OCPP Cloud authentication.

Required payload:

• ocppUrl
• ocppInitialChargePointPassword
• ocppDefaultIdTag

Enable Zaptec Mode

PUT /installations/{installationId}/mode/zaptec

Switches an installation back to Zaptec authentication.

Optional payload:

• requireAuthorization
• disableAuthorizationWhenOffline

OCPP URL Updates

Endpoint

PUT /chargers/{chargerId}/ocpp-settings

This endpoint continues to update the charger's configured OCPP URL.

It is intended for updating the URL after onboarding has completed.

Required Integration Changes

1. Select the Correct Password Endpoint

Recommended

Use:

POST /chargers/{chargerId}/ocpp/settings/password

when your application stores passwords in plain text.

Zaptec performs the required AuthorizationKey encoding automatically.

Advanced

Use:

POST /chargers/{chargerId}/ocpp/settings/encodedauthorizationkey

only if your backend already generates OCPP AuthorizationKeys.

Do not pre-encode passwords before calling the plain password endpoint.

2. Use the Onboarding Endpoint for New Chargers

For new OCPP integrations, use:

POST /chargers/{chargerId}/onboarding

instead of performing multiple configuration requests individually.

3. Use Installation Mode Endpoints

Switch between Zaptec, OCPP, and OCPP Cloud authentication using the dedicated installation mode endpoints.

Compatibility

• Existing OCPP URL updates remain supported.
• Existing integrations continue to function.
• The new endpoints extend provisioning capabilities without replacing current functionality.
• No existing endpoints have been removed.