# ChargerDojo

- [ChargerDojo documentation](https://docs.chargerdojo.com/index.md): Automate ChargerDojo: register partner endpoints, run OCPI conformance suites and charging journeys, and read the graded reports.
- [What you can do without paying](https://docs.chargerdojo.com/guide/what-is-free.md): The sandbox, the browser simulator and the MCP server are free and need no card. Where the paid line falls, and why the API key sits past it.
- [Plans and pricing](https://docs.chargerdojo.com/guide/plans.md): What each ChargerDojo plan costs and what it unlocks: the free sandbox, Integrate, Automate and Certified, with the capability behind every line.
- [Connect a coding agent](https://docs.chargerdojo.com/guide/connect-a-coding-agent.md): Point Claude Code, Codex, Cursor or any MCP client at ChargerDojo's hosted server, so your agent can answer OCPI questions and read your test runs.
- [Quickstart: your first run from the command line](https://docs.chargerdojo.com/guide/quickstart.md): Run a complete OCPI conformance run against the deployed service from the command line with curl, jq and a cdojo_ API key.
- [Create an API key](https://docs.chargerdojo.com/guide/create-an-api-key.md): Create, store, rotate and revoke the cdojo_ API key that authenticates every request to the ChargerDojo public API from your scripts and CI.
- [API overview](https://docs.chargerdojo.com/api/index.md): Automate ChargerDojo with an API key: partner endpoints, conformance runs, charging journeys, and the graded reports and usage they produce.
- [Automate ChargerDojo](https://docs.chargerdojo.com/guide/index.md): The workflows you can drive with an API key: connect a partner, run conformance suites and charging journeys, then read and share the graded evidence.
- [Connect a partner endpoint](https://docs.chargerdojo.com/guide/connect-a-partner.md): Create a connection for a real partner OCPI endpoint and run the live credentials registration handshake before you test against it.
- [Let a partner register with you](https://docs.chargerdojo.com/guide/let-a-partner-register.md): Issue a registration token so a partner's OCPI client can run the credentials handshake against you, and see the connection appear once they do.
- [Connect a local endpoint](https://docs.chargerdojo.com/guide/connect-a-local-endpoint.md): Test an OCPI implementation running on localhost or inside a VPC by putting a temporary public HTTPS tunnel in front of it, and what that costs you.
- [Use the connector](https://docs.chargerdojo.com/guide/use-the-connector.md): Run dojo-connect beside your OCPI service so we can test it without it ever being reachable from the internet: install, pair, run, and its limits.
- [Run a conformance suite](https://docs.chargerdojo.com/guide/run-a-suite.md): Drive a full conformance sweep, a single module or scenario, or one manual OCPI command against a registered partner endpoint, from the command line.
- [Read your report](https://docs.chargerdojo.com/guide/read-your-report.md): The five verdicts a run can return, why a warning is never a failure, and why a red result can be trusted to name the exact rule that broke.
- [Share a report with your partner](https://docs.chargerdojo.com/guide/share-a-report.md): Mint a public, read-only link to a graded report so a partner can review the evidence without an account. The forwardable artifact is the product.
- [Work with a colleague](https://docs.chargerdojo.com/guide/work-with-a-colleague.md): Invite someone into your organisation, what each role can do, what a colleague shares with you, and what happens to their work when they leave.
- [Run a charging journey](https://docs.chargerdojo.com/guide/run-a-charging-journey.md): Preview a journey plan, start it idempotently, follow it live, and resolve a recovery decision when delivery is uncertain.
- [Author a custom journey](https://docs.chargerdojo.com/guide/author-a-scenario.md): The custom journey JSON shape, the knobs that matter, and how to import, run, and save a journey you wrote by hand or generated from CI.
- [Glossary](https://docs.chargerdojo.com/guide/glossary.md): The OCPI and ChargerDojo terms these guides use: CPO, eMSP, CDR, Token A, sender and receiver, module, and the words that only mean something here.
- [Troubleshooting](https://docs.chargerdojo.com/guide/troubleshooting.md): The status codes the API answers, the failures that actually happen in practice, and how to tell a target failure apart from an outage on our side.
- [List owned connections](https://docs.chargerdojo.com/api-reference/connections/list-owned-connections.md): List every partner endpoint owned by the API key, with each endpoint's roles, OCPI version and current registration status.
- [Create a partner endpoint](https://docs.chargerdojo.com/api-reference/connections/create-a-partner-endpoint.md): Register a partner's OCPI endpoint as a connection you own, setting each side's role, the OCPI version and token. Stays pending until you run the handshake.
- [Run the credentials handshake](https://docs.chargerdojo.com/api-reference/connections/run-the-ocpi-credentials-handshake-for-an-owned-connection.md): Perform the OCPI credentials handshake with a connection you own, exchanging registration tokens so both sides can make authenticated calls once registered.
- [Change a connection's address](https://docs.chargerdojo.com/api-reference/connections/change-a-connections-address.md): Move an owned connection to a new base URL when the partner host changes, keeping its tokens and history, then re-read their endpoints at the new address.
- [Read one owned connection](https://docs.chargerdojo.com/api-reference/connections/read-one-owned-connection.md): Read a single partner endpoint you own by id, including its roles, OCPI version, registration status and the last error if the handshake failed.
- [List runnable conformance suites](https://docs.chargerdojo.com/api-reference/testing/list-runnable-conformance-suites.md): List the conformance test suites you can run against a connection, each with its OCPI version and a short description of what it checks.
- [Start a conformance run](https://docs.chargerdojo.com/api-reference/testing/start-a-conformance-run-against-an-owned-connection.md): Queue a conformance run against a registered connection you own, optionally scoped to one suite or module. Returns the run id to poll for the graded report.
- [Send an OCPI command](https://docs.chargerdojo.com/api-reference/testing/send-one-bounded-ocpi-command-through-an-owned-registered-connection.md): Send a single OCPI command through a registered connection you own and read back the raw HTTP status, OCPI status code and response body.
- [List run reports](https://docs.chargerdojo.com/api-reference/reports/list-owned-run-reports-conformance-and-journeys.md): List the graded reports for every run you own, both conformance runs and charging journeys, with each run's status, OCPI version and pass or fail summary.
- [Read a run report](https://docs.chargerdojo.com/api-reference/reports/read-one-owned-report-optionally-long-polling-an-active-run.md): Read a single run report you own by id. Add the wait query parameter to long-poll an active run until it changes, awaiting a verdict without tight polling.
- [Delete a report you own](https://docs.chargerdojo.com/api-reference/reports/delete-a-report-you-own.md): Delete a run report you own so it leaves your list, and revoke any public share link to it. We keep the record internally for your usage history.
- [Share a report](https://docs.chargerdojo.com/api-reference/reports/issue-a-public-share-token-for-an-owned-report.md): Issue a public share token for a report you own and get a link a partner can open without an account. A report about your own endpoint needs a current plan.
- [Revoke a report share token](https://docs.chargerdojo.com/api-reference/reports/revoke-the-public-share-token-of-an-owned-report.md): Revoke the public share link for a report you own. The existing token stops working immediately and the report is private again.
- [Read plan limits and usage](https://docs.chargerdojo.com/api-reference/usage/read-the-key-owners-plan-limits-and-current-usage.md): Read the API key owner's current plan, along with active connection counts and run usage against the plan's limits, so you can track quota before it bites.
- [Browse the journey catalogue](https://docs.chargerdojo.com/api-reference/journeys/browse-the-journey-catalogue-for-a-target.md): List the charging journey templates, packs and custom journeys available for a target, with the OCPI versions each one supports.
- [Preview a journey plan](https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it.md): Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.
- [Start a journey run](https://docs.chargerdojo.com/api-reference/journeys/start-a-journey-run-from-a-previewed-plan-idempotent.md): Start a journey run from a previewed plan. Pass an Idempotency-Key so a retried request returns the original run instead of starting a second one.
- [Read journey run status](https://docs.chargerdojo.com/api-reference/journeys/read-a-journey-runs-status-and-recovery-options.md): Read the stored status of a journey run you own, including how complete our evidence is and any recovery options the server is offering you now.
- [Cancel a journey run](https://docs.chargerdojo.com/api-reference/journeys/cancel-a-journey-run-you-own.md): Ask a running journey to stop at the next safe point rather than mid-exchange. Cancelling never invents a verdict about the target, and keeps what it graded.
- [Apply a server-offered recovery decision](https://docs.chargerdojo.com/api-reference/journeys/apply-a-server-offered-recovery-decision.md): Apply one of the recovery decisions the server offered for an interrupted run. Only server-computed options are accepted.
- [Page journey run events](https://docs.chargerdojo.com/api-reference/journeys/page-a-journey-runs-events-by-sequence.md): Page through the events of a journey run you own by sequence number, replaying every exchange and assertion it recorded, in the order they happened.
- [Replay then follow run events over SSE](https://docs.chargerdojo.com/api-reference/journeys/replay-then-follow-run-events-over-sse.md): Follow a journey run live over server-sent events, streaming each stage as it happens. Resume after a dropped connection with the Last-Event-ID header.

## OpenAPI Specs

- [public-api](/openapi/public-api.json)