Skip to content

Commit

Permalink
Add API keys to README
Browse files Browse the repository at this point in the history
  • Loading branch information
gcatanese authored Oct 7, 2024
1 parent 96598a1 commit 8f51fa4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,25 @@ git clone https://github.com/adyen-examples/adyen-afp-sample.git
## 2. Set the environment variables
* [BCL API key](https://docs.adyen.com/marketplaces-and-platforms/get-started/): API key for accessing Balance Platform [Configuration API](https://docs.adyen.com/api-explorer/balanceplatform/latest/overview)
* [LEM API key](https://docs.adyen.com/marketplaces-and-platforms/get-started/): API key for accessing [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/latest/overview)
* [API Key](https://docs.adyen.com/development-resources/api-credentials/#generate-api-key): API key for accessing [Checkout API](https://docs.adyen.com/api-explorer/Checkout) and [Management API](https://docs.adyen.com/api-explorer/Management/)
* [Merchant account](https://docs.adyen.com/account/account-structure/#merchant-accounts): the merchant account to to configure and process the payments
* [HMAC key](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures): HMAC key to validate incoming webhook requests

On Linux/Mac/Windows export/set the environment variables.
```shell
export ADYEN_BCL_API_KEY=yourBclApiKey
export ADYEN_LEM_API_KEY=yourLemApiKey
export ADYEN_API_KEY=yourCheckoutApiKey
export ADYEN_MERCHANT_ACCOUNT=yourCheckoutMerchantAccount
export ADYEN_HMAC_KEY=yourHmacKey
```

Alternatively, define the variables in the `config/application.properties`.
```txt
ADYEN_BCL_API_KEY=yourBclApiKey
ADYEN_LEM_API_KEY=yourLemApiKey
ADYEN_API_KEY=yourCheckoutApiKey
ADYEN_MERCHANT_ACCOUNT=yourCheckoutMerchantAccount
ADYEN_HMAC_KEY=yourHmacKey
```

Expand Down

0 comments on commit 8f51fa4

Please sign in to comment.