API for EVerest API clients implementing auth token validator.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to validate token.
{
"headers": {
"replyTo": "string"
},
"payload": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
}
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
Reply to validate token.
Result object containing authorization status enum value and an optional parentIdTag
Reply validate token.
{
"authorization_status": "Accepted",
"evse_ids": [
1
]
}
Available only on servers:
Accepts the following message:
Updated validation result for a given token due to some changes. These can be triggered by TransactionEvent messages or StartTransaction.
Result object containing an updated validation result for a given token. This is needed since certain information can be updated at a later time.
ValidationResultUpdate
{
"connector_id": "1,",
"validation_result": {
"authorization_status": "Accepted",
"certificate_status": "Accepted",
"expiry_time": "2019-08-24T14:15:22Z",
"parent_id_token": {
"value": "string",
"type": "Central"
}
}
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
CommunicationCheck
Request to validate token.
Reply to validate token.
Result object containing authorization status enum value and an optional parentIdTag
Updated validation result for a given token due to some changes. These can be triggered by TransactionEvent messages or StartTransaction.
Result object containing an updated validation result for a given token. This is needed since certain information can be updated at a later time.
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
Authorization Status enum
Certificate status information
Possible energy transfer modes. The modes AC_single_phase_core to DC_unique apply to DIN70121 and ISO15118-2. The other modes DC to WPT apply to ISO15118-20.
Result object containing authorization status enum value and an optional parentIdTag
Result object containing an updated validation result for a given token. This is needed since certain information can be updated at a later time.
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached