PaydayAPI
Principles

Base URL and versioning

One base URL; v1 only gains fields.

View as Markdown
Text
https://payday.direct/api/v1

All endpoints live under /api/v1 on payday.direct, over HTTPS only.

What can change in v1

  • Added: new endpoints, new fields in a response, new optional parameters and new values in a status or type field. Write clients that ignore fields they do not know.
  • Never in v1: a field renamed or removed, a type changed, or a parameter made required.

Anything that would break a client ships as v2, announced in the changelog 90 days ahead, with v1 kept running alongside.

Which version is live

The spec's info.version carries the server release, for example v1 (0.1.265), and every answer's meta.api_version is v1.