# EV Roaming Tester

## Docs

- [Create a partner connection](https://evsim.synergyboat.com/docs/api-reference/connections/create-a-partner-connection.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.
- [List owned connections](https://evsim.synergyboat.com/docs/api-reference/connections/list-owned-connections.md): List every partner connection owned by the API key, with each connection's roles, OCPI version and current registration status.
- [Read one owned connection](https://evsim.synergyboat.com/docs/api-reference/connections/read-one-owned-connection.md): Read a single partner connection you own by id, including its roles, OCPI version, registration status and the last error if the handshake failed.
- [Run the credentials handshake](https://evsim.synergyboat.com/docs/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.
- [Apply a server-offered recovery decision](https://evsim.synergyboat.com/docs/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.
- [Browse the journey catalogue](https://evsim.synergyboat.com/docs/api-reference/journeys/browse-the-journey-catalogue-for-a-target.md): List the charging journey templates, packs and saved scenarios available for a target, with the OCPI versions each one supports.
- [Preview a journey plan](https://evsim.synergyboat.com/docs/api-reference/journeys/compile-and-persist-a-journey-plan-without-executing-it.md): Compile a journey into a runnable plan and persist it without executing, so you can review the stages and preflight before starting a run.
- [Page journey run events](https://evsim.synergyboat.com/docs/api-reference/journeys/page-the-durable-event-ledger-by-sequence.md): Page through the durable event ledger of a journey run by sequence number, replaying every recorded exchange and assertion.
- [Read journey run status](https://evsim.synergyboat.com/docs/api-reference/journeys/read-durable-run-status-integrity-and-recovery-options.md): Read the durable status of a journey run you own, including its execution integrity and any recovery options the server offers.
- [Replay then follow run events over SSE](https://evsim.synergyboat.com/docs/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.
- [Cancel a journey run](https://evsim.synergyboat.com/docs/api-reference/journeys/request-cooperative-cancellation-of-an-owned-run.md): Ask a running journey to stop cooperatively at the next safe point. Cancellation is best-effort and never fabricates a verdict about the target.
- [Start a journey run](https://evsim.synergyboat.com/docs/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.
- [Share a report](https://evsim.synergyboat.com/docs/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 your partner can open without an account. Revoke it any time to make the report private.
- [List run reports](https://evsim.synergyboat.com/docs/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://evsim.synergyboat.com/docs/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.
- [Revoke a report share token](https://evsim.synergyboat.com/docs/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.
- [Soft-delete an owned report](https://evsim.synergyboat.com/docs/api-reference/reports/soft-delete-an-owned-report.md): Soft-delete a run report you own so it no longer appears in your list. The record is retained internally and any public share token is revoked.
- [List runnable conformance suites](https://evsim.synergyboat.com/docs/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.
- [Send an OCPI command](https://evsim.synergyboat.com/docs/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.
- [Start a conformance run](https://evsim.synergyboat.com/docs/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.
- [Read plan limits and usage](https://evsim.synergyboat.com/docs/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.
- [API overview](https://evsim.synergyboat.com/docs/api/index.md): Automate the EV Roaming Tester with an API key: partner connections, conformance runs, charging journeys, and the graded reports and usage they produce.
- [Author a custom scenario](https://evsim.synergyboat.com/docs/guide/author-a-scenario.md): The scenario JSON shape, the knobs that matter, and how to import, run, and save a scenario you wrote by hand or generated from CI.
- [Connect a partner endpoint](https://evsim.synergyboat.com/docs/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.
- [Create an API key](https://evsim.synergyboat.com/docs/guide/create-an-api-key.md): Create, store, rotate and revoke the evrt_ API key that authenticates every request to the EV Roaming Tester public API from your scripts and CI.
- [Automate the tester](https://evsim.synergyboat.com/docs/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.
- [Quickstart: your first run from the command line](https://evsim.synergyboat.com/docs/guide/quickstart.md): Run a complete OCPI conformance run against the deployed service from the command line with curl, jq and an evrt_ API key.
- [Read your report](https://evsim.synergyboat.com/docs/guide/read-your-report.md): The three verdicts a run can return, why a warning is never a failure, and why a red result can be trusted to name the exact clause that broke.
- [Run a charging journey](https://evsim.synergyboat.com/docs/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.
- [Run a conformance suite](https://evsim.synergyboat.com/docs/guide/run-a-suite.md): Drive the full compliance suite, a single module or scenario, or one manual OCPI command against a registered partner connection, from the command line.
- [Share a report with your partner](https://evsim.synergyboat.com/docs/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.
- [Troubleshooting](https://evsim.synergyboat.com/docs/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.
- [EV Roaming Tester documentation](https://evsim.synergyboat.com/docs/index.md): Automate the EV Roaming Tester: register partner connections, run OCPI conformance suites and charging journeys, and read the graded reports.

## OpenAPI Specs

- [public-api](https://evsim.synergyboat.com/docs/openapi/public-api.json)