> ## Documentation Index
> Fetch the complete documentation index at: https://evsim.synergyboat.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# EV Roaming Tester documentation

> Automate the EV Roaming Tester: register partner connections, run OCPI conformance suites and charging journeys, and read the graded reports.

The [EV Roaming Tester](https://evsim.synergyboat.com) checks what your OCPI implementation
does against the vendored specification. Most of it runs in the browser; this documentation
covers the parts you automate with an **API key** and the guides that walk each workflow.

```bash theme={null}
curl -fsS "https://evsim.synergyboat.com/api/v1/usage" \
  -H "Authorization: Bearer $EVRT_KEY" | jq '.data'
```

## Start here

<CardGroup cols={2}>
  <Card title="API overview" icon="book-open" href="/docs/api">
    The one public API, its authentication, and the response envelope.
  </Card>

  <Card title="Create an API key" icon="key" href="/docs/guide/create-an-api-key">
    Sign in, create the key in Settings, store it once.
  </Card>

  <Card title="Quickstart" icon="play" href="/docs/guide/quickstart">
    A complete conformance run from the command line.
  </Card>

  <Card title="Connect a partner" icon="plug" href="/docs/guide/connect-a-partner">
    Register a real partner endpoint and run against it.
  </Card>

  <Card title="Run a charging journey" icon="route" href="/docs/guide/run-a-charging-journey">
    Drive a full charging story and watch it live.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/docs/guide/troubleshooting">
    What each status code means, and the ones CI scripts get wrong.
  </Card>
</CardGroup>

## What is public

Only the operations in the **API reference** section are the public API. Everything else the
application does, including the interactive simulator, entity editing, and account and key
management, is browser functionality, not part of the automated contract.
