Transitioning to AuthenticationType for OcppNative (16-06-2025)

At Zaptec, we're continuously enhancing our APIs to provide a more intuitive and consistent experience for our integrators. As part of this commitment, we're introducing an important update regarding how you designate OcppNative installations. This change will go into effect from 16-06-2025.

This article outlines the upcoming change, the reasons behind it, and what actions you may need to take.

What's changing?

installation.InstallationType is being replaced by installation.AuthenticationType when setting an installation to OcppNative mode. Effective 16-06-2025, to update an installation to OcppNative, you should use installation.AuthenticationType with a value of 3. The previous method, using installation.InstallationType with a value of 2, is now deprecated and will no longer be supported after this date.

The OcppCentralSystemUrl field remains unchanged and is still required when updating an installation to OcppNative.

Why this change?

Improved Clarity: Using AuthenticationType more accurately reflects the nature of OcppNative as an authentication and communication protocol, rather than a generic "installation type."
Enhanced Consistency: This change aligns our API fields with industry best practices and provides a more consistent naming convention across our platform.
Future-Proofing: It prepares our API for future enhancements and broader authentication capabilities without ambiguity.

Action required

Please ensure your integration is updated to use installation.AuthenticationType = 3 when setting installations to OcppNative mode. Failure to update by 16-06-2025 will result in requests using installation.InstallationType = 2 failing.

Old Request (Deprecated after 16-06-2025):

PUT {{urlBaseApi}}/installation/[id] HTTP/1.1
Authorization: Bearer {{token}}
Content-Type: application/json

{
    "InstallationType" : 2,
    "OcppCentralSystemUrl": "wss://test.com"
}

New Request (Correct for future use):

PUT {{urlBaseApi}}/installation/[id] HTTP/1.1
Authorization: Bearer {{token}}
Content-Type: application/json

{
    "AuthenticationType" : 3,
    "OcppCentralSystemUrl": "wss://test.com"
}

ℹ️
We understand that these updates may require some adjustments on your end, and we are here to support you. If you have any questions or need further assistance, please reach out to our support team using this link: https://help.zaptec.com/hc/en-001/requests/new
We appreciate your collaboration and look forward to continuing to improve our API experience together!