Getting Started
Integrating Breez SDK - Nodeless (Spark Implementation) into your application takes just a few minutes.
Before you begin, make sure to read the repository README carefully. Then follow these steps to get started:
- Installing the SDK
- Testing and development
- Initializing the SDK
- Getting the SDK info
- Listening to events
- Adding logging
- Spark status
API Key
The Nodeless Breez API key must be set for the SDK to work. You can request one by filling our form here, or programmatically:
curl -d "fullname=<full name>" -d "company=<company>" -d "email=<email>" -d "message=<message>" \
https://breez.technology/contact/apikey
UX Guidelines
When implementing the Breez SDK, we recommend reading through our UX Guidelines to provide a consistent and intuitive experience for your end-users.
Many of the guidelines are implemented in Misty Breez, which you can use as the primary UX reference during SDK implementation.
WebAssembly (WASM) Demo
Looking for a quick way to try the SDK in your browser? Check out the WebAssembly (WASM) demo app:
- Live demo: https://breez-sdk-spark-example.vercel.app
- Repo: breez/breez-sdk-spark-example
Note: The demo is for demonstration purposes only and not intended for production use.
Support
Have a question for the team? Join us on Telegram or email us at contact@breez.technology.