aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2026-01-08 16:14:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Roy Sheinfeld
2025-02-20 15:30:09 +02:00
committed by GitHub
parent 869ad2be56
commit b895350680
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -16,7 +16,7 @@ Currently implemented endpoints:
- [AWS cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
- [Access to AWS account](https://signin.aws.amazon.com/signup?request_type=register)
- [Breez SDK - Nodeless implementation API key](https://breez.technology/request-api-key/#contact-us-form-sdk)
- 12 word BIP 39 seed
- 12 words BIP 39 seed (TBA: use Misty Breez to generate it)
## Deployment
Deployment to AWS with [cloudformation](./cloudformation.yaml).
@@ -25,17 +25,22 @@ Deployment to AWS with [cloudformation](./cloudformation.yaml).
Follow [AWS guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) to install and configure cli.
### Create SSM parameters for Breez credentials
From the command line, run the following commands:
```
aws ssm put-parameter \
--name "/breez-nodeless/api_key" \
--value "<REPLACE_WITH_BREEZ_API_KEY>" \
--type SecureString
```
```
aws ssm put-parameter \
--name "/breez-nodeless/seed_phrase" \
--value "<REPLACE_WITH_SEED_WORDS>" \
--type SecureString
```
```
aws ssm put-parameter \
--name "/breez-nodeless/api_secret" \
--value "<REPLACE_WITH_DESIRED_API_AUTHENTICATION_KEY>" \
@@ -47,13 +52,13 @@ aws cloudformation create-stack \
--stack-name breez-integration \
--template-body file://cloudformation.yaml \
--capabilities CAPABILITY_IAM
```
```
# Monitor the stack creation. At the begining it will return "CREATE_IN_PROGRESS", you have to wait until it changes to "CREATE_COMPLETE"
aws cloudformation describe-stacks \
--stack-name breez-integration \
--query 'Stacks[0].StackStatus'
```
### Retrieve the API endpoints after successful deployment
@@ -61,9 +66,8 @@ aws cloudformation describe-stacks \
aws cloudformation describe-stacks \
--stack-name breez-integration \
--query 'Stacks[0].Outputs'
```
Output will look like this:
Output should look like this:
```
root@2edec8635e65:/# aws cloudformation describe-stacks --stack-name breez-integration --query 'Stacks[0].Outputs'
[