Transactions API

Welcome to the EVC-net Transaction API! This API provides access to retrieve transactions from the EVC-net platform. With seamless integration capabilities, developers can efficiently access and manage transaction data programmatically. This documentation serves as a comprehensive guide to help you navigate the functionalities and endpoints available through this API.

Acceptance Endpoint: https://evc-a.evc-net.com/

Production Endpoint: https://evc-net.com/

Authentication

To access the API endpoints, authentication via API keys is required. Please refer to the authentication section for details on how to authenticate your requests.

Rate Limits

Requests to the API are subject to rate limits to ensure system stability and reliability. Details on rate limits can be found in the Rate Limiting section.

Getting Started

Begin exploring the API functionalities by reviewing the available endpoints and their respective parameters. Detailed explanations and usage examples are provided for each endpoint to facilitate integration into your application.

We’re excited to see how you leverage the EVC-net Transaction API to streamline transaction retrieval within your application. If you have any questions or need assistance, please refer to the contact support@lastmilesolutions.com.

Let’s get started!

Authentication

Accessing the EVC-net API endpoints requires authentication using an API token generated for a system user account. Follow these steps to generate an authentication token:

Creating a System User Account

1. Contact Last Mile Solutions: LMS will create a System User Account dedicated to the transaction API access.
2. Generate Authentication Token: Under the newly created system user account we will generate an authentication token. This token will serve as the key for API authentication.

Authentication Format

To authenticate your requests to the EVC-net API, use the following format in the HTTP header:

Authorization: token {authentication_token}

• Replace {authentication_token} with the authentication token generated for the system user account.
• Include this header in your API requests to authenticate and gain access to the endpoints.

Example:

• GET /api/rest/customer HTTP/1.1
• Host: evc-a.evc-net.com
• Authorization: token your_authentication_token_here

Security Note

Keep your authentication token secure and avoid sharing it in publicly accessible areas. Treat the token as sensitive information to prevent unauthorized access to your account and data.

Interface & Endpoint

Example endpoint structure:

• GET /api/rest/transaction/list/{providerId}/{pageNr}?{fromDate}

Example headers structure:

Key	Value
accept	application/json
X-Request-ID	(int) Generated ID example, 12345
x-api-version	1.1.1
Authorization	Token { authentication_token }

GET to URL : https://evc-a.evc-net.com/api/rest/transaction/list/{providerId}/{pageNr}?{fromDate}

Field	Data Type	Value (Example)
status_message	String	valid
status_code	Integer	200
timestamp	String (DateTime)	2023-11-28T14:54:34Z
data	Array
– transaction_log_id	Integer	99999999
– recharge_spot_name	String	Sample Recharge Spot
– recharge_spot_id	Integer	12345678
– recharge_spot_address	String	123 Main Street
– recharge_spot_zip	String	12345
– recharge_spot_city	String	Sample City
– card_internal_id	String	CARD-123456
– card_external_id	String	EXT-987654
– paid_customer_price	Float	25.00
– contract_id	String	CONTRACT-ABC123
– type	String	Sample Type
– consumer_cost_breakdown	Object	Timeslot: 1<br>Start Date: 01-Jan-2023 12:00:00<br>End Date: 01-Jan-2023 12:30:00<br>Energy: 10.5<br>Charging Duration: 00:30:00<br>Start: 1.00<br>Kwh: 10.00<br>Minute: 5.00<br>Parking Minute: 3.00<br>Price: 25.00<br>Tariff Start: 1.00<br>Tariff Kwh: 2.00<br>Tariff Minute: 1.00<br>Tariff Parking Minute: 0.50
– currency_details	Object	Currency Consumer: USD<br>Currency Station: USD<br>Conversion Rate: N/A<br>Conversion Fee: USD 0.00
– total_energy	Float	10.5
– incoming_cdr_id	String	CDR-123
– outgoing_cdr_id	String	CDR-456
– evse_id	String	EVSE-12345678
– transaction_log_id	Integer	88888888
– recharge_spot_name	String	Example Charging Station
– recharge_spot_id	Integer	87994231
– recharge_spot_address	String	456 Elm Street
– recharge_spot_zip	String	54321
– recharge_spot_city	String	Sampleville
– card_internal_id	String	CARD-654321
– card_external_id	String	EXT-123456
– paid_customer_price	Float	20.00
– contract_id	String	CONTRACT-XYZ789
– type	String	Public
– consumer_cost_breakdown	Object	Currency Consumer: EUR<br>Currency Station: EUR<br>Conversion Rate: N/A<br>Conversion Fee: EUR 0.00
– total_energy	Float	8.75
– incoming_cdr_id	String	CDR-789
– outgoing_cdr_id	String	CDR-012
– evse_id	String	EVSE-87654321

Status codes & error messages

Status Code	Message
200	Success response
300	Invalid response
301	All items fetched, no more items to return
403	Wrong version