Charge Assist API Descriptions and timeouts
Charge Assist API acceptance environment
Charge Assist API production environment
Some of the API's are coupled with third-party API's internal and external and might depend on the performance.
| Name | Method | Endpoint | Timeout (sec) |
|---|---|---|---|
| Map User Drivers | POST | /ca/account/mapuseranddrivers | 100 |
| Apptoken | PUT | /ca/token/{appToken} | 100 |
| Apptoken with Driver ID | PUT | /ca/token | 100 |
| Fetch Sessions related to Apptoken | GET | /ca/token/{appToken}/sessions | 100 |
| Favorites | GET | /ca/favorites/{appToken}/locations | 100 |
| Favorite | DEL | /ca/favorites/{appToken}/location/{id} | 100 |
| Mark a location as a favorite | POST | /ca/favorites/{appToken}/location/{id} | 100 |
| Favorites V2 | GET | /ca/v2.1/favorites/{appToken}/locations | 100 |
| Favorite V2 | DEL | /ca/v2.1/favorites/{appToken}/location/{id} | 100 |
| Mark a location as a favorite V2 | POST | /ca/v2.1/favorites/{appToken}/location/{id} | 100 |
| Location | GET | /ca/locations/{id} | 100 |
| Location by EVSE | GET | /ca/locations/evse/{evseUid} | 100 |
| Locations BoundingBox | GET | /ca/locations/boundingbox?bottomLeftLat={bottomLeftLat}&bottomLeftLng={bottomLeftLng}&topRightLat={topRightLat}&topRightLng={topRightLng} | 120 |
| Locations Nearby | GET | /ca/locations/nearby?latitude={latitude}&longitude={longitude} | 120 |
| Locations Search | GET | /ca/locations/search?q={q} | 100 |
| Location V2 | GET | /ca/v2.1/locations/{id} | 100 |
| Location by EVSE V2 | GET | /ca/v2.1/locations/evse/{evseUid} | 100 |
| Locations BoundingBox V2 | GET | /ca/v2.1/locations/boundingbox[?bottomLeftLat][&bottomLeftLng][&topRightLat][&topRightLng] | 120 |
| Locations Nearby V2 | GET | /ca/v2.1/locations/nearby[?latitude][&longitude] | 120 |
| Locations Search V2 | GET | /ca/v2.1/locations/search[?q] | 100 |
| Add PSP Payment Method | PUT | /ca/payment/{appToken}/psp/{pspSource}/paymentmethod | 100 (depends on external API) |
| ChargeCard | DEL | /ca/payment/{appToken}/{id} | 100 |
| ChargeCard | PUT | /ca/payment/{appToken}/chargecard | 100 (depends on Billing) |
| External PaymentMethod | PUT | /ca/payment/{appToken}/external | 100 |
| Link ChargeCard to Wallet | POST | /ca/payment/{appToken}/chargecard/link | 100 |
| Unlink ChargeCard to Wallet | POST | /ca/payment/{appToken}/chargecard/unlink | 100 |
| Wallet | GET | /ca/payment/{appToken}/wallet | 100 |
| Get Private Location for Apptoken | GET | /ca/privatelocations/{appToken} | 100 |
| Parse QR | POST | /ca/qr | 100 |
| High Priority Charging for the Session | POST | /ca/session/highpriority[?appToken] | 100 (depends on SmartCharging) |
| Session | GET | /ca/session/status?appToken={appToken}&chargeSessionId={chargeSessionId} | 100 |
| Session Start | POST | /ca/session/start?appToken={appToken} | 180 (depends on Ocpi/Billing) |
| Session Stop | POST | /ca/session/stop?appToken={appToken} | 180 (depends on Ocpi) |
| Update Mileage | POST | /ca/session/{appToken}/mileage | 100 |
| High Priority Charging for the Session V2 | POST | /ca/v2.1/session/highpriority[?appToken] | 100 (depends on SmartCharging) |
| Session | GET | /ca/v2.1/session/status?appToken={appToken}&chargeSessionId={chargeSessionId} | 100 |
| Session Start V2 | POST | /ca/v2.1/session/start?appToken={appToken} | 180 (depends on Ocpi/Billing) |
| Session Stop V2 | POST | /ca/v2.1/session/stop?appToken={appToken} | 180 (depends on Ocpi) |
| Update Mileage V2 | POST | /ca/v2.1/session/{appToken}/mileage | 100 |
| Bulk Tariff | POST | /ca/bulktariff/{appToken}/paymentmethod/{paymentMethodId} | 120 (depends on Billing) |
| Tariff | GET | /ca/tariff/{appToken}/evse/{locationId}/{evseUid} | 100 (depends on Billing) |
Updated 2 months ago