Migration from HERE EV Charge Points API v2 to v3
Migration guide
This migration guide provides information on important topics to consider, when migrating from the HERE EV Charge Points API v2 to the HERE EV Charge Points API v3.
API schemas
The HERE EV Charge Points API v2 draws loosely from the eMI3 (eMobility ICT Interoperability Innovation) specification, while the HERE EV Charge Points API v3 follows the OCPI (Open Charge Point Interface) version 2 specification. The HERE EV Charge Points API v3 schema includes additional new attributes on top of the OCPI. However, the enumerations are identical between the HERE EV Charge Points API v3 and OCPI.
| Data element | HERE EV Charge Points API v2 | HERE EV Charge Points API v3 | OCPI definition |
|---|---|---|---|
| EV Charging station | Pool | Location | The location object describes the charging location and its properties. A location is a group of Electric Vehicle Supply Equipments (EVSEs) that belong together. Typically, the location object is the exact location of the group of EVSEs, but it can also be the entrance of a parking garage which contains these EVSEs. You can specify the exact way to reach each EVSE further by its own properties. |
| Station | |||
| EVSE, sometimes also a station, a charge point, or a stall | EVSE | EVSE | The EVSE object describes the component that controls power supply to a single EV, which always belongs to a location object. The object only contains directions to get from the location itself to its EVSEs (floor, physical_reference, or directions). |
| Connector, sometimes a port, a plug or a gun | Connector | Connector | A connector is a socket, a cable or a plug available for an EV to use. A single EVSE may provide multiple connectors but only one of them can be in use at the same time. A connector always belongs to an EVSE object. |
Note
The id of the location object on HERE EV Charge Points API v3 corresponds to the poolId on HERE EV Charge Points API v2. The charging location IDs match in the two APIs.
Connector mapping table
| standard (EV CP API v3) | connectorType.id (EV CP API v2) | connectorType.name (EV CP API v2) | More information |
|---|---|---|---|
| DOMESTIC_B | 5 | Domestic plug/socket type B (NEMA 5-15) | Domestic plug/socket type B (NEMA 5-15) |
| NEMA_5_20 | 6 | NEMA 5-20 (3 pin) | Domestic plug/socket type B (NEMA 5-20 (3 pin)) |
| DOMESTIC_D | 7 | Domestic plug/socket type D (BS 546, 3 pin, 5A) | Domestic plug/socket type D (BS 546, 3 pin, 5A) |
| DOMESTIC_E | 8 | Domestic plug/socket type E (CEE 7/5) | Domestic plug/socket type E (CEE 7/5) |
| DOMESTIC_F | 9 | Domestic plug/socket type F (CEE 7/4 (Schuko)) | Domestic plug/socket type F (CEE 7/4 (Schuko)) |
| DOMESTIC_G | 11 | Domestic plug/socket type G (BS 1363, IS 401 & 411, MS 58) | Domestic plug/socket type G (BS 1363, IS 401 & 411, MS 58) |
| DOMESTIC_H | 12 | Domestic plug/socket type H (SI 32) | Domestic plug/socket type H (SI 32) |
| DOMESTIC_I | 13 | Domestic plug/socket type I (AS/NZS 3112) | Domestic plug/socket type I (AS/NZS 3112) |
| DOMESTIC_K | 20 | Domestic plug/socket type K (Section 107-2-D1) | Domestic plug/socket type K (Section 107-2-D1) |
| DOMESTIC_L | 22 | Domestic plug/socket type L (CEI 23-16/VII) | Domestic plug/socket type L (CEI 23-16/VII) |
| DOMESTIC_M | 23 | Domestic plug/socket type M (South African 15 A/250 V) | Domestic plug/socket type M (South African 15 A/250 V) |
| CHADEMO | 29 | JEVS G 105 (CHAdeMO) | CHAdeMO |
| IEC_62196_T1 | 30 | IEC 62196-2 type 1 (SAE J1772) | Type 1 (SAE J1772) |
| IEC_62196_T2 | 31 | IEC 62196-2 type 2 (Type 2) | Type 2 |
| IEC_62196_T3C | 32 | IEC 62196-2 type 3c (SCAME) | Type 3c |
| IEC_62196_T1_COMBO | 33 | IEC 62196-3 type 1 combo (SAE J1772) | CCS1 |
| IEC_62196_T2_COMBO | 34 | IEC 62196-3 type 2 combo (Mennekes) | CCS2 |
| IEC_60309_2_SINGLE_16 | 35 | IEC 60309 : industrial P + N + E (AC) | Industrial blue AC |
| IEC_60309_2_THREE_16 IEC_60309_2_THREE_32 IEC_60309_2_THREE_64 | 36 | IEC 60309 : industrial 3P + E + N (AC) | Industrial red AC |
| DOMESTIC_J | 42 | Domestic plug/socket type J (SEV 1011) (T13, T23) | Domestic plug/socket type J (SEV 1011) (T13, T23) |
| SAE_J3400 | 43 | Tesla Connector | North American Charging Standard (NACS, SAE J3400) |
| DOMESTIC_A | 48 | Domestic plug/socket type A (NEMA 1-15, 2 pins) | Domestic plug/socket type A (NEMA 1-15, 2 pins) |
| DOMESTIC_C | 49 | Domestic plug/socket type C (CEE 7/17, 2 pins) | Domestic plug/socket type C (CEE 7/17, 2 pins) |
| IEC_62196_T3A | 50 | IEC 62196-2 type 3a (SCAME) | Type 3a |
| NEMA_14_50 | 51 | Domestic plug/socket type B (NEMA 14-50) | Domestic plug/socket type B (NEMA 14-50) |
| GBT_AC | 52 | GB/T (Chinese) AC connector | GB/T (Chinese) AC connector |
| GBT_DC | 53 | GB/T (Chinese) DC connector | GB/T (Chinese) DC connector |
| NEMA_6_50 | 55 | Domestic plug/socket type B (NEMA 6-50) | Domestic plug/socket type B (NEMA 6-50) |
| NEMA_6_30 | 56 | Domestic plug/socket type B (NEMA 6-30) | Domestic plug/socket type B (NEMA 6-30) |
| NEMA_10_30 | 57 | Domestic plug/socket type B (NEMA 10-30) | Domestic plug/socket type B (NEMA 10-30) |
| NEMA_10_50 | 58 | Domestic plug/socket type B (NEMA 10-50) | Domestic plug/socket type B (NEMA 10-50) |
| NEMA_14_30 | 59 | Domestic plug/socket type B (NEMA 14-30) | Domestic plug/socket type B (NEMA 14-30) |
| DOMESTIC_N | 61 | Domestic plug/socket type N (NBR 14136, 3 pins) | Domestic plug/socket type N (NBR 14136, 3 pins) |
| DOMESTIC_O | 62 | Domestic plug/socket type O (TIS 166-2549, 3 pins) | Domestic plug/socket type O (TIS 166-2549, 3 pins) |
| CHAOJI | 63 | ChaoJi connector (CHAdeMO 3.0) | ChaoJi |
| PANTOGRAPH_TOP_DOWN | 64 | Cross-rail pantograph (SAE J3105-1) | Cross-rail pantograph (SAE J3105-1) |
| PANTOGRAPH_BOTTOM_UP | 65 | Bus-up pantograph (SAE J3105-2) | Bus-up pantograph (SAE J3105-2) |
| TESLA_R | 66 | Tesla Connector R | Tesla Roadster connector |
| MCS | 67 | MCS (Megawatt Charging System) | Megawatt Charging System (MCS) |
| TESLA_S | 68 | Tesla Proprietary Connector (TESLA_S) | Tesla connector Model-S-type (oval, 5 pin). Compatible with Tesla car models only. See NACS for further information |
| CONNECTOR_TYPE_UNDEFINED | 0 | Not used | |
| UNRECOGNIZED | 1 | Not used | |
| 2 | Not used | ||
| 3 | Small Paddle Inductive | Deprecated | |
| 4 | Large Paddle Inductive | Deprecated | |
| 10 | Domestic plug/socket type E+F (CEE 7/7) | Deprecated | |
| 14 | Domestic plug/socket type I (CPCS-CCC) | Deprecated | |
| 15 | Domestic plug/socket type I (IRAM 2073) | Deprecated | |
| 16 | Domestic plug/socket type J (SEV 1011) (T13) | Deprecated | |
| 17 | Domestic plug/socket type J (SEV 1011) (T15) | Deprecated | |
| 18 | Domestic plug/socket type J (SEV 1011) (T23) | Deprecated | |
| 19 | Domestic plug/socket type J (SEV 1011) (T25) | Deprecated | |
| 21 | Domestic plug/socket type K (Thailand TIS 166 - 2549) | Deprecated | |
| 24 | Domestic plug/socket type IEC 60906-1 (3 pin) | Deprecated | |
| 25 | AVCON Connector | Deprecated | |
| 26 | Tesla Connector (high power wall) | Deprecated | |
| 27 | Tesla Connector (universal mobile) | Deprecated | |
| 28 | Tesla Connector (spare mobile) | Deprecated | |
| 37 | IEC 60309 : industrial 2P + E (AC) | Deprecated | |
| 38 | IEC 60309 : industrial P + N + E (AC) (CEEPlus) | Deprecated | |
| 39 | IEC 60309 : industrial 3P + N + E (AC) (CEEPlus) | Deprecated | |
| 40 | Better place plug/socket | Deprecated | |
| 41 | Marechal plug/socket | Deprecated | |
| 44 | IEC 61851-1 | Deprecated | |
| 45 | IEC 62196-2 type 2 (SAE J1772) | Deprecated | |
| 46 | IEC 60309 : industrial 2P + E (DC) | Deprecated | |
| 47 | I-type AS/NZ 3112 (Australian 15A/240V) | Deprecated | |
| 54 | IEC 62196-2 type 2 | Deprecated | |
| 60 | Domestic plug/socket type M (BS 546, 3 pin, 15A) | Deprecated |
Status mapping table
The following table lists differences in the EVSE real-time status codes between OCPI (via HERE EV Charge Points API v3) and eMI3 (via HERE EV Charge Points API v2).
| EV API v3 | EV API v2 | OCPI definition |
|---|---|---|
| AVAILABLE | AVAILABLE | The EVSE or connector is able to start a new charging session. |
| BLOCKED | UNAVAILABLE | The EVSE or connector is not accessible because of a physical barrier, commonly a car parking in front of the charging point. |
| CHARGING | OCCUPIED | The EVSE or connector is in use. |
| INOPERATIVE | OUT_OF_SERVICE | The EVSE or connector is not yet active, or temporarily not available for use, but not broken/defect. |
| OUTOFORDER | OUT_OF_SERVICE | The EVSE or connector is currently out of order, one or more parts or components may have failed |
| PLANNED | OFFLINE | EVSE or connector planned, operating soon. |
| REMOVED | OFFLINE | EVSE or connector discontinued/removed. |
| RESERVED | RESERVED | EVSE or connector reserved for a particular EV driver and unavailable for other drivers. |
| UNKNOWN | OTHER | No status information available (also used when offline). |
| OPERATIONAL | OTHER | Non-OCPI status for offline use cases |
Updated last month