Commit 2c224e8f authored by Daniel Gultsch's avatar Daniel Gultsch
Browse files

docuemnt request headers

parent de42f239
......@@ -7,8 +7,14 @@ The HTTP API is responsible for registration, password resets and SMS verificati
### `GET /authentication/$phoneNumber`
Requests an SMS containing a 6 digit code to be send to `$phoneNumber`. The number is formatted according to E.164 (leading +, including the contry code, no spaces).
#### Header
* `Accept-Language`: ISO 639-1 two letter language code. Will be used to change the language of the SMS
* `Installation-Id`: Randomly generated (at install time) UUID supplied by the client. Will be used for rate limiting on top of per number and per IP limits. Limits users on requesting multiple SMS for multiple phone numbers.
* `User-Agent`: Formatted to `Name/Version` with version being formatted according to [Sementic Versioning](https://semver.org/).
#### Response Codes
### `POST /password`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment