AMPECO Public API Integration Guide
Explore and integrate with the AMPECO EV Charging Platform Public API.
IMPORTANT: Update Reference Docs First
Before using the reference documentation, ensure you have the latest API spec:
bash scripts/fetch-and-generate.sh
This fetches the latest OpenAPI spec from https://developers.ampeco.com/openapi/ and regenerates all reference files.
Prerequisites: curl and jq must be installed:
- macOS:
brew install jq
- Ubuntu/Debian:
apt-get install jq
Getting Started
1. Get API Access
Contact your AMPECO Customer Success Manager or generate a token in:
Back Office → API Access Tokens
2. Base URL
https://{tenantUrl}/public-api/
Replace {tenantUrl} with your organization's tenant URL.
3. Authentication
curl -H "Authorization: Bearer {your-api-token}" \
https://{tenantUrl}/public-api/resources/charge-points/v2.0/
Quick Reference
Response Format: JSON with data wrapper
{
"data": [...],
"links": { "first": "...", "last": "...", "prev": null, "next": "..." },
"meta": { "current_page": 1, "per_page": 100, "total": 250 }
}
Path Patterns:
- Resources:
/public-api/resources/{resource-name}/v{X.Y}/
- Actions:
/public-api/actions/{target}/v{X.Y}/{id}/{action}
- Notifications:
/public-api/notifications/v{X.Y}/
Endpoint Quick Index
| Resource |
Version |
Operations |
| Admins |
v1.0 |
Read |
| Authorizations |
v1.0, 2.0, 2.1 |
Read |
| Booking Requests |
v1.0 |
Create, Read |
| Bookings |
v1.0 |
Read |
| Cdrs |
v2.0 |
Read |
| Charge Point Downtime Periods |
v1.0 |
Create, Delete, Read, Update |
| Charge Point Models |
v1.0 |
Create, Delete, Read, Update |
| Charge Point Vendors |
v1.0 |
Create, Delete, Read, Update |
| Charge Points |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Circuits |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Configuration Templates |
v1.0 |
Create, Delete, Read, Update |
| Consent History |
v1.0 |
Read |
| Consents |
v1.0 |
Create, Read |
| Contact Details |
v2.0 |
Delete, Read, Update |
| Cp Models |
v1.0 |
Create, Delete, Read, Update |
| Cp Vendors |
v1.0 |
Create, Delete, Read, Update |
| Currencies |
v2.0 |
Create, Delete, Read, Update |
| Currency Rates |
v1.0 |
Create, Delete, Read, Update |
| Custom Fees |
v2.0 |
Read |
| Downtime Period Notices |
v1.0 |
Create, Delete, Read, Update |
| Electricity Meters |
v1.0 |
Create, Delete, Read, Update |
| Electricity Rates |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Evse Downtime Periods |
v1.0 |
Create, Delete, Read, Update |
| Evses |
v2.0, 2.1 |
Create, Delete, Read, Update |
| Faqs |
v2.0 |
Create, Delete, Read, Update |
| Firmware Versions |
v1.0 |
Read |
| Flexibility Activation Requests |
v1.0 |
Read |
| Flexibility Assets |
v1.0 |
Create, Delete, Read, Update |
| Id Tags |
v2.0 |
Create, Delete, Read, Update |
| Installation And Maintenance Companies |
v1.0 |
Create, Delete, Read, Update |
| Installer Jobs |
v1.0 |
Create, Delete, Read, Update |
| Invoices |
v1.0 |
Read |
| Issues |
v1.0 |
Create, Delete, Read, Update |
| Locations |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Operators |
v1.0 |
Read |
| Parking Spaces |
v1.0 |
Create, Delete, Read, Update |
| Partner Contracts |
v1.0 |
Create, Delete, Read, Update |
| Partner Expenses |
v1.0, 1.1, 1.2 |
Read |
| Partner Invites |
v1.0 |
Create, Delete, Read, Update |
| Partner Revenues |
v1.0, 1.1, 1.2 |
Read |
| Partner Settlement Reports |
v1.0 |
Create, Delete, Read, Update |
| Partners |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Payment Terminals |
v1.0, 1.1 |
Create, Delete, Read, Update |
| Provisioning Certificates |
v2.0 |
Create, Delete, Read, Update |
| Receipts |
v2.0 |
Read |
| Reservations |
v1.0 |
Read |
| Rfid Tags |
v1.0 |
Create, Delete, Read, Update |
| Roaming Connections |
v2.0 |
Read |
| Roaming Operators |
v2.0 |
Create, Delete, Read, Update |
| Roaming Platforms |
v1.0 |
Read |
| Roaming Providers |
v2.0 |
Create, Delete, Read, Update |
| Roaming Tariffs |
v2.0 |
Read, Update |
| Security Events |
v2.0 |
Read |
| Security Events Log |
v2.0 |
Read |
| Sessions |
v1.0 |
Read |
| Settings |
v1.0 |
Read |
| Sub Operators |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Subscription Plans |
v1.0, 2.0 |
Create, Delete, Read, Update |
| Subscriptions |
v1.0 |
Read |
| Tariff Groups |
v1.0 |
Create, Delete, Read, Update |
| Tariff Snapshots |
v1.0 |
Read |
| Tariffs |
v1.0 |
Create, Delete, Read, Update |
| Tax Identification Numbers |
v2.0 |
Create, Delete, Read, Update |
| Taxes |
v2.0 |
Create, Delete, Read, Update |
| Templates |
v1.0 |
Read |
| Terms And Policies |
v2.0 |
Read |
| Top Up Packages |
v2.0 |
Create, Delete, Read, Update |
| Transactions |
v1.0 |
Create, Read, Update |
| User Groups |
v1.0 |
Create, Delete, Read, Update |
| Users |
v1.0, 1.1 |
Create, Delete, Read, Update |
| Utilities |
v1.0 |
Create, Delete, Read, Update |
| Vendor Error Codes |
v2.0 |
Create, Delete, Read, Update |
| Vouchers |
v2.0, 2.1 |
Create, Delete, Read, Update |
Run bash scripts/fetch-and-generate.sh to update this index
Actions: See reference/endpoints-index.md for charge point, user, reservation, and notification actions.
Data Model Overview
Understanding how AMPECO entities relate helps you choose the right endpoints.
Operator (tenant scope)
├── Location → ChargePoint → EVSE → Session
├── User → Session, PartnerInvite
├── Partner → ChargePoint (owned), PartnerInvite (users)
└── Tariff, SubscriptionPlan
Common Use Cases:
| Task |
Key Endpoints |
| Charge point stats |
sessions?filter[chargePointId]=, sessions/{id}/consumption-stats |
| User billing |
sessions?filter[userId]=, transactions?filter[userId]=, receipts |
| Fleet management |
charge-points?filter[partnerId]=, partner-invites, partner-revenues |
| Start/stop charging |
actions/charge-point/{id}/start/{evse}, actions/charge-point/{id}/stop/{session} |
See reference/data-model.md for detailed relationships and recipes.
Common Patterns
Pagination
Cursor pagination (default, recommended):
GET /public-api/resources/users/v1.0?per_page=25
GET /public-api/resources/users/v1.0?cursor={next_cursor}&per_page=25
Page pagination (legacy support):
GET /public-api/resources/users/v1.0?page=1&per_page=25
Filtering
Use filter[fieldName]=value format:
GET /public-api/resources/sessions/v1.0?filter[userId]=123
GET /public-api/resources/sessions/v1.0?filter[status]=active
GET /public-api/resources/sessions/v1.0?filter[startedAfter]=2024-01-01T00:00:00Z
Includes
Embed related resources with include[]=relationName:
GET /public-api/resources/charge-points/v1.0?include[]=evses&include[]=location
Error Responses
{
"message": "Unauthenticated."
}
Status codes: 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 422 (Validation Error)
How to Use This Skill
- First: Run
bash scripts/fetch-and-generate.sh to get latest docs
- Find endpoints: Load
reference/endpoints-index.md
- Check schemas: Load
reference/schemas-index.md
- Check patterns: Load
reference/common-patterns.md for pagination, filtering, errors
- See deprecated: Load
reference/deprecation-map.md
Reference Files
reference/data-model.md - Entity relationships and use case recipes
reference/endpoints-index.md - Complete list of all endpoints
reference/schemas-index.md - Schema summaries
reference/deprecation-map.md - Deprecated endpoints
reference/common-patterns.md - Pagination, filtering, errors
Live Documentation
https://developers.ampeco.com
1---2name: ampeco-public-api3description: |4 Explore AMPECO Public API endpoints, schemas, and develop integrations5 with the EV charging platform. Use for API exploration, building6 integrations, or understanding available endpoints.7 Trigger keywords: "ampeco api", "public api", "ev charging api", "ampeco integration"8allowed-tools: Read, Glob, Grep, Bash, WebFetch9metadata:10 source: https://skillmd.com/skills/ampeco/ampeco-public-api11---1213# AMPECO Public API Integration Guide1415Explore and integrate with the AMPECO EV Charging Platform Public API.1617---1819## IMPORTANT: Update Reference Docs First2021Before using the reference documentation, ensure you have the latest API spec:2223```bash24bash scripts/fetch-and-generate.sh25```2627This fetches the latest OpenAPI spec from https://developers.ampeco.com/openapi/ and regenerates all reference files.2829**Prerequisites**: `curl` and `jq` must be installed:30- macOS: `brew install jq`31- Ubuntu/Debian: `apt-get install jq`3233---3435## Getting Started3637### 1. Get API Access3839Contact your AMPECO Customer Success Manager or generate a token in:40**Back Office → API Access Tokens**4142### 2. Base URL4344```45https://{tenantUrl}/public-api/46```4748Replace `{tenantUrl}` with your organization's tenant URL.4950### 3. Authentication5152```bash53curl -H "Authorization: Bearer {your-api-token}" \54 https://{tenantUrl}/public-api/resources/charge-points/v2.0/55```5657---5859## Quick Reference6061**Response Format**: JSON with `data` wrapper62```json63{64 "data": [...],65 "links": { "first": "...", "last": "...", "prev": null, "next": "..." },66 "meta": { "current_page": 1, "per_page": 100, "total": 250 }67}68```6970**Path Patterns**:71- Resources: `/public-api/resources/{resource-name}/v{X.Y}/`72- Actions: `/public-api/actions/{target}/v{X.Y}/{id}/{action}`73- Notifications: `/public-api/notifications/v{X.Y}/`7475---7677<!-- BEGIN:QUICK_INDEX -->78## Endpoint Quick Index7980| Resource | Version | Operations |81|----------|---------|------------|82| **Admins** | v1.0 | Read |83| **Authorizations** | v1.0, 2.0, 2.1 | Read |84| **Booking Requests** | v1.0 | Create, Read |85| **Bookings** | v1.0 | Read |86| **Cdrs** | v2.0 | Read |87| **Charge Point Downtime Periods** | v1.0 | Create, Delete, Read, Update |88| **Charge Point Models** | v1.0 | Create, Delete, Read, Update |89| **Charge Point Vendors** | v1.0 | Create, Delete, Read, Update |90| **Charge Points** | v1.0, 2.0 | Create, Delete, Read, Update |91| **Circuits** | v1.0, 2.0 | Create, Delete, Read, Update |92| **Configuration Templates** | v1.0 | Create, Delete, Read, Update |93| **Consent History** | v1.0 | Read |94| **Consents** | v1.0 | Create, Read |95| **Contact Details** | v2.0 | Delete, Read, Update |96| **Cp Models** | v1.0 | Create, Delete, Read, Update |97| **Cp Vendors** | v1.0 | Create, Delete, Read, Update |98| **Currencies** | v2.0 | Create, Delete, Read, Update |99| **Currency Rates** | v1.0 | Create, Delete, Read, Update |100| **Custom Fees** | v2.0 | Read |101| **Downtime Period Notices** | v1.0 | Create, Delete, Read, Update |102| **Electricity Meters** | v1.0 | Create, Delete, Read, Update |103| **Electricity Rates** | v1.0, 2.0 | Create, Delete, Read, Update |104| **Evse Downtime Periods** | v1.0 | Create, Delete, Read, Update |105| **Evses** | v2.0, 2.1 | Create, Delete, Read, Update |106| **Faqs** | v2.0 | Create, Delete, Read, Update |107| **Firmware Versions** | v1.0 | Read |108| **Flexibility Activation Requests** | v1.0 | Read |109| **Flexibility Assets** | v1.0 | Create, Delete, Read, Update |110| **Id Tags** | v2.0 | Create, Delete, Read, Update |111| **Installation And Maintenance Companies** | v1.0 | Create, Delete, Read, Update |112| **Installer Jobs** | v1.0 | Create, Delete, Read, Update |113| **Invoices** | v1.0 | Read |114| **Issues** | v1.0 | Create, Delete, Read, Update |115| **Locations** | v1.0, 2.0 | Create, Delete, Read, Update |116| **Operators** | v1.0 | Read |117| **Parking Spaces** | v1.0 | Create, Delete, Read, Update |118| **Partner Contracts** | v1.0 | Create, Delete, Read, Update |119| **Partner Expenses** | v1.0, 1.1, 1.2 | Read |120| **Partner Invites** | v1.0 | Create, Delete, Read, Update |121| **Partner Revenues** | v1.0, 1.1, 1.2 | Read |122| **Partner Settlement Reports** | v1.0 | Create, Delete, Read, Update |123| **Partners** | v1.0, 2.0 | Create, Delete, Read, Update |124| **Payment Terminals** | v1.0, 1.1 | Create, Delete, Read, Update |125| **Provisioning Certificates** | v2.0 | Create, Delete, Read, Update |126| **Receipts** | v2.0 | Read |127| **Reservations** | v1.0 | Read |128| **Rfid Tags** | v1.0 | Create, Delete, Read, Update |129| **Roaming Connections** | v2.0 | Read |130| **Roaming Operators** | v2.0 | Create, Delete, Read, Update |131| **Roaming Platforms** | v1.0 | Read |132| **Roaming Providers** | v2.0 | Create, Delete, Read, Update |133| **Roaming Tariffs** | v2.0 | Read, Update |134| **Security Events** | v2.0 | Read |135| **Security Events Log** | v2.0 | Read |136| **Sessions** | v1.0 | Read |137| **Settings** | v1.0 | Read |138| **Sub Operators** | v1.0, 2.0 | Create, Delete, Read, Update |139| **Subscription Plans** | v1.0, 2.0 | Create, Delete, Read, Update |140| **Subscriptions** | v1.0 | Read |141| **Tariff Groups** | v1.0 | Create, Delete, Read, Update |142| **Tariff Snapshots** | v1.0 | Read |143| **Tariffs** | v1.0 | Create, Delete, Read, Update |144| **Tax Identification Numbers** | v2.0 | Create, Delete, Read, Update |145| **Taxes** | v2.0 | Create, Delete, Read, Update |146| **Templates** | v1.0 | Read |147| **Terms And Policies** | v2.0 | Read |148| **Top Up Packages** | v2.0 | Create, Delete, Read, Update |149| **Transactions** | v1.0 | Create, Read, Update |150| **User Groups** | v1.0 | Create, Delete, Read, Update |151| **Users** | v1.0, 1.1 | Create, Delete, Read, Update |152| **Utilities** | v1.0 | Create, Delete, Read, Update |153| **Vendor Error Codes** | v2.0 | Create, Delete, Read, Update |154| **Vouchers** | v2.0, 2.1 | Create, Delete, Read, Update |155156*Run `bash scripts/fetch-and-generate.sh` to update this index*157158**Actions**: See `reference/endpoints-index.md` for charge point, user, reservation, and notification actions.159<!-- END:QUICK_INDEX -->160161---162163## Data Model Overview164165Understanding how AMPECO entities relate helps you choose the right endpoints.166167```168Operator (tenant scope)169├── Location → ChargePoint → EVSE → Session170├── User → Session, PartnerInvite171├── Partner → ChargePoint (owned), PartnerInvite (users)172└── Tariff, SubscriptionPlan173```174175**Common Use Cases:**176177| Task | Key Endpoints |178|------|---------------|179| Charge point stats | `sessions?filter[chargePointId]=`, `sessions/{id}/consumption-stats` |180| User billing | `sessions?filter[userId]=`, `transactions?filter[userId]=`, `receipts` |181| Fleet management | `charge-points?filter[partnerId]=`, `partner-invites`, `partner-revenues` |182| Start/stop charging | `actions/charge-point/{id}/start/{evse}`, `actions/charge-point/{id}/stop/{session}` |183184See `reference/data-model.md` for detailed relationships and recipes.185186---187188## Common Patterns189190### Pagination191192**Cursor pagination** (default, recommended):193```194GET /public-api/resources/users/v1.0?per_page=25195GET /public-api/resources/users/v1.0?cursor={next_cursor}&per_page=25196```197198**Page pagination** (legacy support):199```200GET /public-api/resources/users/v1.0?page=1&per_page=25201```202203### Filtering204205Use `filter[fieldName]=value` format:206```207GET /public-api/resources/sessions/v1.0?filter[userId]=123208GET /public-api/resources/sessions/v1.0?filter[status]=active209GET /public-api/resources/sessions/v1.0?filter[startedAfter]=2024-01-01T00:00:00Z210```211212### Includes213214Embed related resources with `include[]=relationName`:215```216GET /public-api/resources/charge-points/v1.0?include[]=evses&include[]=location217```218219### Error Responses220221```json222{223 "message": "Unauthenticated."224}225```226227Status codes: 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 422 (Validation Error)228229---230231## How to Use This Skill2322331. **First**: Run `bash scripts/fetch-and-generate.sh` to get latest docs2342. **Find endpoints**: Load `reference/endpoints-index.md`2353. **Check schemas**: Load `reference/schemas-index.md`2364. **Check patterns**: Load `reference/common-patterns.md` for pagination, filtering, errors2375. **See deprecated**: Load `reference/deprecation-map.md`238239## Reference Files240241- `reference/data-model.md` - Entity relationships and use case recipes242- `reference/endpoints-index.md` - Complete list of all endpoints243- `reference/schemas-index.md` - Schema summaries244- `reference/deprecation-map.md` - Deprecated endpoints245- `reference/common-patterns.md` - Pagination, filtering, errors246247## Live Documentation248249https://developers.ampeco.com