ViriCiti SDK¶
Introduction¶
The ViriCiti SDK allows users to interact or request data from the ViriCiti framework without accessing a grapical web interface. This document contains all of the neccesary information regarding how to access the SDK and what is available on the SDK.
Pre-requisite¶
API Key¶
In order to connect to the ViriCiti SDK, it is necessary to retrieve a valid api-key from https://portal.viriciti.com/sdk. This api-key is user-based and is generated on the user’s profile page. To successfully make requests the API supports two methods of authentication, explained below. Both authentication methods work for all API endpoints available in the SDK, regardless of the protocol.
Providing the api-key using headers:
"x-api-key" : "936afc31-fdf0-4f6b-b85b-02f115733fb4"
Providing the api-key using query parameter:
https://sdk.viriciti.com/secured?apiKey=936afc31-fdf0-4f6b-b85b-02f115733fb4
Notes:
1) This is an example api-key and will not work for actual requests.
Terminology¶
| Term | Definition | Additional info |
|---|---|---|
| acl | Access Control List (Authorized Items) | |
| soc | Battery State of Charge | |
| odo | Vehicle odometer | |
| vid | ViriCiti vehicle identifier | See here how to retrieve them |
| identity | ViriCiti Charging Station identifier | |
| transaction | The id representing a charge session | |
| server | ViriCiti SDK server |