{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f2dd7951-6f46-4d0e-8f02-b3810aaab997","name":"Eevion API Documentation","description":"\n\n# The Eevion Integrated EV Charging API from [Hypercharge](https://www.hypercharge.com/)\n\n## Developing with the Eevion API\n\n**Development Stations**\n\nDevelopment with Eevion typically requires access to an OCPP 1.6J or 2.0J compliant EV charger. If you do not have access to a charger for development, please contact Hypercharge to discuss your options for testing. There are also open source OCPP charger simulators which you may choose to use for development. Hypercharge does not currently offer a simulation environment.\n\nIf you received your station from Hypercharge, it should be configured for you to use out of the box once it has been installed. If you are connecting a pre-existing station to Hypercharge, contact [commissioning@hypercharge.com](https://mailto:commissioning@hypercharge.com) for information on configuring your station to our network.\n\n**Rate Limits**\n\nBy default, each API key can make 60 requests in a 60 second period. If you exceed this limit, your requests will return an HTTP status code of 429. This limit can be increased if required by contacting your account representative.\n\n**Server Side API**\n\nEevion is a server-side API meant for communication between your server and the Eevion API. Your application should pass requests to Eevion on behalf of your client facing applications. It is prohibited to call the Eevion API directly from client devices and Hypercharge does not provide SDKs for this purpose.\n\n## Getting Started\n\n> **Note:** This documentation assumes that you have already been granted access to the Hypercharge Quantev ([https://app.hypercharge.com/quantev](https://app.hypercharge.com/quantev)) platform and permission to access Eevion. You will receive an email to set up you account when it has been created. If you do not have an account, contact your account representative or [support@hypercharge.com](https://mailto:support@hypercharge.com) to get set up. \n \n\nEevion is designed to make it simple to control charging sessions on your Hypercharge charging stations from any application.\n\nThere are three steps to get started with development:\n\n**1) Ensure you have access to your development site and stations in Quantev**\n\nGenerally, the sites and stations that you have access to in Quantev will be the same sites and stations that you can control via Eevion. You can confirm that your testing/development stations are available by logging in to [https://app.hypercharge.com/quantev](https://app.hypercharge.com/quantev) and confirming that they are visible to you on the \"Stations\" page.\n\n**2) Get your API key from Quantev**\n\nYou can find your API key in Quantev on the Profile page under the Eevion tab.\n\n\n\n> If you do not see the Eevion tab, your account may not have been enabled for Eevion. Contact us to have this permission added to your account. \n \n\n**3) Get your station ID's**\n\nIn Quantev, navigate to the \"Stations\" page. The station ID is the **Station** column.\n\nYou now have everything you need to started using Eevion! Read on below to learn about running charging sessions, managing your stations, and getting charging data and alerts from the API.\n\n> **Note:** Hypercharge offers a staging/development environment for developing and testing with Eevion. Typically, your development stations will be in this environment. If using the staging environment, **you must append ?environment=staging to the URL**. If you do not include this parameter, your calls will be sent to the production environment. \n \n\n## Charging\n\n\"The%20basic%20EV%20charging%20flow%20via%20Eevion.\"\n\nEV charging via Eevion has three primary steps:\n\n1. **Starting the session** \n To start a charging session via Eevion, use the **session** endpoint and pass the station ID for the station you wish to start the session on. You can connect the charger to a vehicle or simulator before or after you make the start request to Eevion, but do note that some charger models and configurations may have a time limit to start the session, which is typically 1-5 minutes. For more information on controlling timeouts on your specific stations, contact Hypercharge.\n \n2. **Monitoring the session** \n _You can make requests to the_ **session** endpoint specifying the **sessionID** to get up-to-date status, cost, energy, power, and duration information throughout the session. This information can be used to provide live updates to drivers in your applications and/or drive notifications to users.\n \n3. **Ending the charging session** \n The most common way for charging sessions to end is by the driver disconnecting their vehicle from the charging station. When Hypercharge detects that the vehicle has been disconnected, we will send a POST request to the **webhookOnSessionComplete** with the final session cost, energy, and duration. These details are typically used to bill the driver and provide them with a session receipt or history. \n Optionally, you may wish to provide the option for drivers to stop the session via your application or to stop sessions based on various conditions you determine. To do this, make a request to the **session/{sessionID}/stop** endpooint for the relevant session.\n \n\n## Managing Your Stations\n\nIt is possible to send various commands to change the settings for your stations via Eevion. The most commonly used commands are:\n\n- **tariffId,** which allows you to specify the tariff/fee structure for your stations\n \n- **priorityStatus,** which allows you to control the availability of your stations\n \n- **setMessage,** which allows you to set a message to be displayed in a modal to users of the app when they view a station\n \n\n> **Note:** Some commands may require time to be processed. The **webhookOnJobFinished** property allows you to specify a webhook to POST the results of the command. You can request the history of all jobs since a given date by making a **Management history** request. \n \n\nThere is more information about this command in the **Manage Stations** section below.\n\n## **Reporting and Monitoring**\n\nTo retrieve aggregated data about your sites and stations to use for utilization or financial reporting, use the **reporting** endpoint.\n\nTo trigger notifications in a monitoring platform or similar, specify a webhook for these notifications to be sent to in Quantev on the Profile > Eevion page.\n\n\n\nFor more information, see the documentation in the **List exceptions** section below.\n\n#### Need help? We are always available to help you build and support your Eevion integration!\n\nContact your account representative or Hypercharge Support ([support@hypercharge.com](https://mailto:support@hypercharge.com)) if you have any questions or require assistance with any aspect of developing your application or operating your EV chargers.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11098966","team":4449827,"collectionId":"f2dd7951-6f46-4d0e-8f02-b3810aaab997","publishedId":"2s946cgEQ2","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11098966/2s946cgEQ2","privateUrl":"https://go.postman.co/documentation/11098966-f2dd7951-6f46-4d0e-8f02-b3810aaab997","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-07-12T08:54:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e8e91d635cc48e2476d0d2520c733381673b673170fd883374d67102e8bd3561","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s946cgEQ2"}