Add API funds documentation
All checks were successful
build-and-push-ext / build_push (push) Successful in 7s
All checks were successful
build-and-push-ext / build_push (push) Successful in 7s
- Document /api/v1/funds/transfer endpoint - Document /api/v1/funds/check endpoint - Document required Docker socket mounting - Document Bitcoin wallet requirements
This commit is contained in:
parent
7fc16f2d48
commit
4b8cf2b22f
25
docs/API_FUNDS.md
Normal file
25
docs/API_FUNDS.md
Normal file
@ -0,0 +1,25 @@
|
||||
# API Funds - LeCoffre Back Mini
|
||||
|
||||
## Endpoints disponibles
|
||||
- `POST /api/v1/funds/transfer` : Transfert automatique de fonds
|
||||
- `GET /api/v1/funds/check` : Vérification des fonds
|
||||
|
||||
## Configuration requise
|
||||
- Docker socket monté : `/var/run/docker.sock:/var/run/docker.sock`
|
||||
- Accès au container `bitcoin-signet`
|
||||
- Wallets Bitcoin : `mining_mnemonic` et `default`
|
||||
|
||||
## Transfert automatique
|
||||
```bash
|
||||
curl -X POST https://dev4.4nkweb.com/api/v1/funds/transfer \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"amount": 0.01, "source": "mining_mnemonic", "target": "default"}'
|
||||
```
|
||||
|
||||
## Vérification des fonds
|
||||
```bash
|
||||
curl https://dev4.4nkweb.com/api/v1/funds/check
|
||||
```
|
||||
|
||||
## Date
|
||||
2025-09-20
|
Loading…
x
Reference in New Issue
Block a user