aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2025-12-20 06:54:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

secrets and security

Browse Source
This commit is contained in:
Aljaz Ceru
2025-05-28 09:59:10 +02:00
parent 6a3959d9b8
commit 08258d8c7f
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -4,6 +4,9 @@ Breez Payments Rest API is a REST API on top of [Breez Nodeless SDK](https://git
## API documentation ## API documentation
OpenAPI documentation is generated on every instance at ```<api-url>/docs```. It can also be downloaded [here](./openapi.json). OpenAPI documentation is generated on every instance at ```<api-url>/docs```. It can also be downloaded [here](./openapi.json).
## API Key Security
X-API-KEY header serves as authorization method for accessing the API. Anyone that knows the API url and API_SECRET can access your funds, so make sure to protect this secret and to generate a unique and long string. You can use generators like [this](https://1password.com/password-generator) or this(https://www.uuidgenerator.net/).
## Deployment options ## Deployment options

4
fly/README.md
View File

@@ -5,8 +5,8 @@ This document explains deploying breez payments api to fly.io
- Python 3.10+ - Python 3.10+
- Poetry (package manager) - Poetry (package manager)
- Breez Nodeless SDK API key (get one from [Breez](https://breez.technology/)) - [Breez Nodeless SDK API key ](https://breez.technology/request-api-key/#contact-us-form-sdk)
- A valid seed phrase for the Breez SDK wallet - 12 words BIP 39 seed ( use [Misty Breez](https://github.com/breez/misty-breez) to generate it)
## Installation ## Installation