The XUMM API allows developers to deliver sign requests (payloads) to app users. A payload is a JSON formatted transaction template for a transaction on the XRP ledger.
XUMM app users can scan a QR code or receive a push notification to open the sign request for a transaction. A user views the sign request and either authorizes XUMM to sign it or rejects it. If authorized, the sign request will be signed locally via XUMM, if rejected the sign request is destroyed and the transaction does not happen.
If authorized the transaction can then be sent directly to the XRP ledger. The initiating application will get realtime status updates and after signing, the end user will be returned to the initiating platform.
To make it simple to interact with the XUMM API, and to help build intuitive flows for end users to sign their transactions, we have released the XUMM SDK (pypi) for Python environments.
Pre-requisite
Before beginning this XUMM SDK tutorial, we assume that you are ready to code with your code environment already set up for python. This includes Visual Studio Code (IDE), python, git & virtualenv.
This tutorial consists of five chapters:
1. Get your XUMM API credentials 🔑
2. Prepare your project and start coding 🔨
3. Your first payload 🔔
4. Verify the results ⛑ and push 🚀
5. Security & finishing touch 🎉
Resources 📚
If you want to learn more about the XUMM SDK PY, platform, documentation, etc., make sure to check out:
The XUMM SDK (PY) readme
The XUMM SDK (PY) source code
The XUMM API documentation & API reference
XUMM (end user) support docs
In case of questions: support@xumm.app
Thank you XRP Community!
... For checking, correcting & testing the SDK & tutorial!
@wietse, @technotip, @calvincs, @wenusch, @alloyxrp, @rippleitinnz, @Ubbah, @enclavia, @WormholeMech, @Chicles_, @3N0RYM, @XrpSpark, @devnullinator, @Vetjes, @kevinking64, @Kujistudios, @nodehash, @4thMadHatter, @Vkumzy, @CarpeDiemXRP, @Hex539, @xrplosion1, @chemical_realm, @RossMacFirdeen
Top comments (0)