>_

ampeco-public-api

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

$ Installieren

git clone https://github.com/majiayu000/claude-skill-registry /tmp/claude-skill-registry && cp -r /tmp/claude-skill-registry/skills/development/ampeco-public-api ~/.claude/skills/claude-skill-registry

// tip: Run this command in your terminal to install the skill

SKILL.md
View on GitHub →

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

Endpoint Quick Index

ResourceVersionOperations
Authorizationsv1.0, 2.0Read
Booking Requestsv1.0Create, Read
Bookingsv1.0Read
Cdrsv2.0Read
Charge Point Downtime Periodsv1.0Create, Delete, Read, Update
Charge Point Modelsv1.0Create, Delete, Read, Update
Charge Point Vendorsv1.0Create, Delete, Read, Update
Charge Pointsv1.0, 2.0Create, Delete, Read, Update
Circuitsv1.0, 2.0Create, Delete, Read, Update
Configuration Templatesv1.0Create, Delete, Read, Update
Consentsv1.0Create, Read
Contact Detailsv2.0Delete, Read, Update
Cp Modelsv1.0Create, Delete, Read, Update
Cp Vendorsv1.0Create, Delete, Read, Update
Currenciesv2.0Create, Delete, Read, Update
Currency Ratesv1.0Create, Delete, Read, Update
Custom Feesv2.0Read
Downtime Period Noticesv1.0Create, Delete, Read, Update
Electricity Metersv1.0Create, Delete, Read, Update
Electricity Ratesv1.0, 2.0Create, Delete, Read, Update
Evse Downtime Periodsv1.0Create, Delete, Read, Update
Evsesv2.0, 2.1Create, Delete, Read, Update
Faqsv2.0Create, Delete, Read, Update
Firmware Versionsv1.0Read
Flexibility Activation Requestsv1.0Read
Flexibility Assetsv1.0Create, Delete, Read, Update
Id Tagsv2.0Create, Delete, Read, Update
Installer Jobsv1.0Create, Delete, Read, Update
Invoicesv1.0Read
Locationsv1.0, 2.0Create, Delete, Read, Update
Parking Spacesv1.0Create, Delete, Read, Update
Partner Contractsv1.0Create, Delete, Read, Update
Partner Expensesv1.0, 1.1Read
Partner Invitesv1.0Create, Delete, Read, Update
Partner Revenuesv1.0, 1.1Read
Partner Settlement Reportsv1.0Create, Delete, Read, Update
Partnersv1.0, 2.0Create, Delete, Read, Update
Payment Terminalsv1.0Create, Delete, Read, Update
Provisioning Certificatesv2.0Create, Delete, Read, Update
Receiptsv2.0Read
Reservationsv1.0Read
Rfid Tagsv1.0Create, Delete, Read, Update
Roaming Connectionsv2.0Read
Roaming Operatorsv2.0Create, Delete, Read, Update
Roaming Platformsv1.0Read
Roaming Providersv2.0Create, Delete, Read, Update
Roaming Tariffsv2.0Read, Update
Security Eventsv2.0Read
Security Events Logv2.0Read
Sessionsv1.0Read
Settingsv1.0Read
Sub Operatorsv1.0Read
Subscription Plansv1.0, 2.0Create, Delete, Read, Update
Subscriptionsv1.0Read
Tariff Groupsv1.0Create, Delete, Read, Update
Tariff Snapshotsv1.0Read
Tariffsv1.0Create, Delete, Read, Update
Tax Identification Numbersv2.0Create, Delete, Read, Update
Taxesv2.0Create, Delete, Read, Update
Templatesv1.0Read
Terms And Policiesv2.0Read
Top Up Packagesv2.0Create, Delete, Read, Update
Transactionsv1.0Create, Read, Update
User Groupsv1.0Create, Delete, Read, Update
Usersv1.0Create, Delete, Read, Update
Utilitiesv1.0Create, Delete, Read, Update
Vendor Error Codesv2.0Create, Delete, Read, Update
Vouchersv2.0, 2.1Create, 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:

TaskKey Endpoints
Charge point statssessions?filter[chargePointId]=, sessions/{id}/consumption-stats
User billingsessions?filter[userId]=, transactions?filter[userId]=, receipts
Fleet managementcharge-points?filter[partnerId]=, partner-invites, partner-revenues
Start/stop chargingactions/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

Repository

majiayu000
majiayu000
Author
majiayu000/claude-skill-registry/skills/development/ampeco-public-api
0
Stars
0
Forks
Updated8h ago
Added1w ago

Actions

View on GitHubDownload ZIPReport Issue

Related Skills

skill-writer
pytorch/pytorch
95.4k
docstring
pytorch/pytorch
95.4k
at-dispatch-v2
pytorch/pytorch
95.4k
add-uint-support
pytorch/pytorch
95.4k
skill-creator
openai/codex
54.7k