Redume/Kekkai
1
0
Fork 0
mirror of https://github.com/Redume/Kekkai.git synced 2025-02-23 12:43:12 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: create endopint list
Some checks failed
Create and publish a Docker image / build-and-push-server (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-chart (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-CR (push) Has been cancelled
Details
Deploy docs / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Данил 2024-11-18 12:58:58 +03:00
parent 29f185adcf
commit 76a064daeb
2 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/endpoints/list-endpoints.md Normal file
View file

@ -0,0 +1,16 @@
## API Base URL
All requests to our API should be directed to the URL below:
```
https://kekkai-api.redume.su/api/
```
## API Endpoints
Kekkai has 3 API endpoints: `getRate`, `getChart` and `configurations`. Below you will find a list of parameters that each endpoint requires and a description of what the API does.
| Service | API Endpoint | Description |
|--------------|--------------------------------------------------------|--------------------------------------------------------------------|
| Get Rate | `https://kekkai-api.redume.su/api/getRate/` | Get currency exchange rate for a specific day or period |
| Create Chart | `https://kekkai-api.redume.su/api/getChart` | Creating a chart with exchange rate |
| Get Config | `https://kekkai-api.redume.su/api/configurations/json` | Get instance config file |

1
mkdocs.yml
View file

@ -15,6 +15,7 @@ nav:
- Manual: getting-started/manual.md
- Contributing: getting-started/contributing.md
- Endpoints:
- Endpoints list: endpoints/list-endpoints.md
- Get currency rate - /api/getRate: endpoints/get-rate.md
- Create Charts - /api/getChart: endpoints/create-chart.md
- Config: