AMPECO Public API Integration Guide

VerifiedSafe

Explore AMPECO Public API endpoints, schemas, and develop integrations with the EV charging platform. Use for API exploration, building integrations, or understanding available endpoints.

Sby Skills Guide Bot
DevelopmentIntermediate
7/25/2026
Claude CodeCursor
#ampeco#ev-charging#public-api#integration

Recommended for

Automated summary

This skill enables exploration of the AMPECO public API for EV charging platforms and development of integrations.

Strengths

  • Comprehensive documentation of endpoints and schemas.
  • Clear authentication guide with curl examples.
  • Procedure to update reference files via a bash script.

Limitations

  • Requires running a bash script to fetch the latest spec.
  • Depends on curl and jq being installed.
  • API access requires a token provided by AMPECO.
When to use it

Use this skill when you need to interact with the AMPECO API, whether to explore endpoints, retrieve data, or set up integrations.

When not to use it

Do not use it if you lack a bash environment or do not have a valid AMPECO API token.

Security analysis

Safe
Quality score92/100

The skill runs a bash script to fetch an OpenAPI spec from a trusted source using curl and jq, which is legitimate for documentation generation. No destructive, exfiltrating, or obfuscated commands are present.

No concerns found

How this analysis is made

Examples

List charge points
Using the AMPECO public API, list all charge points with their IDs and statuses.
Get API reference
Fetch the latest AMPECO API OpenAPI spec and show me all available endpoints.
Create a location
Create a new location in AMPECO with name 'Downtown Station' and address '123 Main St'.

name: ampeco-public-api description: | Explore AMPECO Public API endpoints, schemas, and develop integrations with the EV charging platform. Use for API exploration, building integrations, or understanding available endpoints. Trigger keywords: "ampeco api", "public api", "ev charging api", "ampeco integration" allowed-tools: Read, Glob, Grep, Bash, WebFetch

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}/

<!-- BEGIN:QUICK_INDEX -->

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.

<!-- END:QUICK_INDEX -->

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

  1. First: Run bash scripts/fetch-and-generate.sh to get latest docs
  2. Find endpoints: Load reference/endpoints-index.md
  3. Check schemas: Load reference/schemas-index.md
  4. Check patterns: Load reference/common-patterns.md for pagination, filtering, errors
  5. 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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/ampeco-public-api-integration-guide-mrzxup1n/download' --output '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md.part' && mv '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md.part' '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Glob, Grep, Bash, WebFetch

Original excerpt: 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}/

<!-- BEGIN:QUICK_INDEX -->

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md' && test -s '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/ampeco-public-api' && cp -R '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n' '.claude/skills/ampeco-public-api'

Cursor
test -f '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md' && test -s '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/ampeco-public-api' && cp -R '.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n' '.cursor/skills/ampeco-public-api'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/ampeco-public-api-integration-guide-mrzxup1n'

openskills read 'ampeco-public-api-integration-guide-mrzxup1n'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/ampeco-public-api-integration-guide-mrzxup1n/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills