icrc/docs/api/README.md

17 lines
667 B
Markdown
Raw Permalink Normal View History

# ICRC API
ICRC Clients use an HTTP API to communicate with the server, which is going to be described in this part of the ICRC
docs.
## Authentication
Most API endpoints require you to ensure, that you have a user account.
To do that, [Bearer Authentication](https://swagger.io/docs/specification/authentication/bearer-authentication/) is
used. You can get Bearer tokens using
the [`/account/auth`](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/api/endpoints/account/auth.md)
endpoint.
## Endpoints
There are docs for every endpoint
over [here](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/api/endpoints/).