Accessing the API

IP filtering

Plugsurfing does not currently use any IP filtering to access the API.

Access control is based on the API key exchanged during the Credentials module handshake.

If this change partners will be informed well in advance to be able to adapt.

Rate limiting

Please see our Fair Usage Policy for general details on rate limiting.

We will return a 429 HTTP response code when the limit is reached. Currently no rate limiting headers like Retry-After are returned to automatically back off.

Additionally, there is a soft currently non-enforced limit on Location pull for the Roam OCPI API.

You are allowed to do Location pull API requests up to once per minute (pagination excluded).

Unique ids

To simplify for partners connecting to Plugsurfing, the below ids are unique across all CPOs exposed via the API.

Location module:

• Location id
• EVSE uid
• Connector id

Session module:

• Session id

CDR module:

• CDR id