Merchant-API-Key header.
Create an API key
API keys are created in the authenticated Vanryx Dashboard. There is no public API endpoint for creating keys.1
Open Merchant Service
Sign in to the Vanryx Dashboard and open Merchant Service.
2
Generate the key
In Generate API Key:
- Enter a Key Name.
- Select at least one item under Accepted Crypto Currencies.
- Select Generate API Key.
3
Copy and save the key
The Dashboard shows Created API Key and asks you to Copy and save your API key. Copy it into your server-side secret storage.
Authenticate requests
Send the key in this header, exactly as shown:Authentication errors
Keep your key secret
- Keep keys in server-side secret storage.
- Never put keys in browser or client-side code, URLs, source control, or logs.
- If a key is compromised, deactivate or delete it in the Dashboard where that option is available, then generate a replacement key.
Rate limits
Create Invoice is limited to 10 requests per minute. Other API routes may also return HTTP429. Their effective limits and any rate-limit response headers are not documented. Handle 429 responses by backing off before you retry.