api/docs/README.md

33 lines
789 B
Markdown

# API
All API endpoints are accessible with this base URL: `https://api.nerdcult.net/`.
Some API endpoints require an Authorization HTTP header.
The token for this can be aquired using the `/account/authenticate` endpoint.
## Implementation Status
- `/account`
- [X] `/register`
- [X] `/verify`
- [X] `/authenticate`
- [X] `/delete`
- [X] `/tokens`
- [X] `/tokens`
- [ ] `/follows`
- [ ] `/followers`
- [ ] `/deactivate`
- [ ] `/activate`
- `/user/`
- [ ] `/info`
- [ ] `/follow`
- [ ] `/follows`
- [ ] `/followers`
- [ ] `/projects`
- `/project`
- [ ] `/create`
- [ ] `/info`
- [ ] `/join`
## TODO
- Password checking on registration
- usage examples
- anonymized account deletion reason
- account bound rate limit