Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Open Charge Map Connector
Overview
The Open Charge Map Connector provides seamless integration with the Open Charge Map API, enabling access to a global database of electric vehicle (EV) charging locations. The connector supports actions to retrieve charging station data, reference data, user authentication, and user-submitted comments and media, as well as the API’s OpenAPI specification. This connector acts as a proxy to streamline data retrieval for applications in navigation, EV management, and user engagement.
Integration Overview
This document provides a detailed guide for each integration point of the Open Charge Map API, including its purpose, configuration, parameters, and workflow support.
Supported Integration Action Points
- getPOI: Retrieves a list of EV charging locations (Points of Interest, POIs) based on geographic or other filters.
- getReferenceData: Retrieves core reference data (e.g., charger types, operators, countries) for interpreting POI data.
- authenticateUser: Authenticates a user to obtain a JWT token for submitting comments or media.
- submitComment: Submits a user comment or check-in for a specific charging location.
- submitMediaItem: Submits a photo for a specific charging location.
- getOpenAPI: Retrieves the OpenAPI specification for the API.
Detailed Integration Documentation
POI Retrieval
| Action | getPOI |
| Purpose | Retrieves a list of EV charging locations (POIs) filtered by criteria such as location, country, or charger type. This is the primary entry point for accessing charging station data. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
Reference Data Retrieval
| Action | getReferenceData |
| Purpose | Retrieves core reference data (e.g., charger types, connection types, countries) for interpreting POI data or building selection interfaces. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
User Authentication
| Action | authenticateUser |
| Purpose | Authenticates a user with an Open Charge Map account to obtain a JWT token for submitting comments or media. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
Comment Submission
| Action | submitComment |
| Purpose | Submits a user comment or check-in for a specific charging location to enhance community-driven data. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
Media Item Submission
| Action | submitMediaItem |
| Purpose | Submits a photo for a specific charging location to enhance visual documentation. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
OpenAPI Specification Retrieval
| Action | getOpenAPI |
| Purpose | Retrieves the OpenAPI 3.0.3 specification (YAML) for the Open Charge Map API, useful for documentation, testing, or client generation. |
| Parameters |
|
| Configuration |
|
| Output |
|
| Workflow Example |
|
Workflow Creation with the Connector
Example Workflow: Charging Station Data Collection and Contribution
Retrieve Reference Data
- Execute the getReferenceData action with key to fetch charger types, connection types, and countries.
- Save IDs (e.g., ConnectionTypeID, CountryID) for filtering or UI elements.
Query Charging Stations
- Execute the getPOI action with key, countrycode=US, and maxresults=10 to fetch charging stations.
- Process the response to display stations on a map or in a list.
Authenticate User
- Execute the authenticateUser action with key, emailaddress, and password to obtain a JWT token.
- Save the access_token for authenticated actions.
Submit User Comment
- Use a chargePointID from getPOI and commentTypeID from getReferenceData.
- Execute the submitComment action with key, chargePointID, comment, and Authorization header.
- Confirm submission for community feedback.
Submit Media Item
- Convert a photo to Base64 and use a chargePointID from getPOI.
- Execute the submitMediaItem action with key, chargePointID, imageDataBase64, and Authorization header.
- Verify photo upload for visual documentation.
Retrieve API Specification
- Execute the getOpenAPI action with key to fetch the API spec.
- Use the YAML for documentation or client generation.
Troubleshooting Swagger UI Issues
CORS Restrictions
-
- Check the browser’s Developer Tools (F12, Network tab) for CORS errors (No ‘Access-Control-Allow-Origin’ header).
- Use a CORS proxy or host Swagger UI locally:
SHELL
npm install -g http-server
http-server /path/to/swagger-ui --cors
- Contact Open Charge Map support to confirm CORS support.
OpenAPI Specification Errors
- Validate the spec from getOpenAPI using swagger-cli validate openapi.yaml.
- Fix errors like missing items for array parameters (e.g., countryid, operatorid).
Large Responses
- Limit responses with parameters like maxresults=10 or compact=true for getPOI.
- Disable Swagger UI syntax highlighting if hosting locally.
Authentication Issues
- Ensure the API key (key=68bfccab-cb66-449f-9b0c-e4d8452990d1) is set in the “Authorize” dialog.
- For submitComment and submitMediaItem, include the JWT token as Authorization: Bearer YourJWTToken.
Hosting Issues
- Avoid running Swagger UI from a file:// URL. Host it on a web server (e.g., http://localhost:8080).
Pricing
iSolution logo - white - transparent 250 px