English
Getting Started Overview
OOLIN provides infrastructure for building digital asset wallets through APIs. Connect accounts to your customers and combine external deposits, balance queries, account transfers, external withdrawals, and transaction records into your service.
This section prepares your integration environment and credentials for the first authenticated request. Continue with the Wallet tutorials to implement testnet deposits and withdrawals, then use the same wallet capabilities for Digital Payment payments and settlement where needed.
What you can build with OOLIN
| Capability | Use in your service | Related concepts |
|---|---|---|
| Account provisioning | Connect and reuse wallet accounts for customers and businesses | Users, Accounts, and Wallets |
| Deposits | Provide asset/network destinations and confirm receipt | Deposit Addresses, Deposit Flow |
| Balances and transaction records | Display spendable funds and changes in balances | Balances and Ledger |
| External withdrawals | Send assets to external wallets and track completion | Withdrawal Flow |
| Internal transfers | Move funds between OOLIN accounts and implement customer-to-merchant payments | OOLIN Service Architecture |
Confirm network and asset availability for your organization. Supported Networks groups the catalog into mainnets and testnets; network support can be expanded upon customer request.
Integration roles
Your customer app calls your backend. The backend authorizes the customer action and sends a signed request to the OOLIN Wallet API.
text
Customer app
→ your backend: customer authentication, authorization, request signing
→ OOLIN Wallet API: accounts, deposits, balances, transfers, withdrawals
→ your backend: retrieve transaction results and update business state
→ customer app: display balances and transaction progressThe API Key identifies your integration; the HMAC Key signs request content. Manage both credentials on your server. Your service manages customer login, orders, and business state, linking them to OOLIN account and transaction IDs. See OOLIN Service Architecture for detailed responsibilities.
Before you start
- Environment and credentials: Obtain a test Base URL, API Key, HMAC Key, and support contact through BPMG onboarding.
- Your backend: Prepare HTTPS requests, HMAC signing, server-side secret storage, and clock synchronization.
- Test asset and network: Confirm available combinations and how to obtain test assets. The examples use the Ethereum Sepolia testnet.
- Example tools: Quickstart and tutorials use Node.js,
curl,openssl, andjq. You can implement your production integration in your backend's language.
Development, test, and production API environments are separate from blockchain mainnets and testnets. Use account, asset, and network IDs and credentials from the target environment.
Your first integration steps
| Step | Document | Expected outcome |
|---|---|---|
| 1 | Environments and Base URLs | Identify the API environment and available networks/assets |
| 2 | API Credentials | Understand each key's role and storage requirements |
| 3 | HMAC Authentication | Understand signing inputs and authentication headers |
| 4 | Your First API Call | Check server time and successfully query active networks |
| 5 | Quickstart | Set up wallet_request, provision an account/destination, and query balances |
To run an example immediately, prepare the environment variables and wallet_request function in Quickstart. This shared shell helper runs HMAC-authenticated requests throughout the tutorials.
Choose a tutorial for your service
| Goal | Next document | Flow |
|---|---|---|
| Customer wallets | Wallet tutorials | Account → deposit address → testnet deposit → balances/ledger → external withdrawal |
| Customer-to-merchant payments | Digital Payment tutorials | Customer funding → internal payment → merchant receipt → external settlement → reconciliation |
Read Core Concepts to understand accounts, addresses, balances, and transactions first. Use the API Reference for complete request and response fields.
Verify the integration and continue
A successful first authenticated request verifies connectivity and authentication. Continue wallet verification on a testnet through actual deposits, withdrawals, and transaction records.
- Persist customer/account mappings and the selected asset, network, and destination.
- Confirm deposit/withdrawal completion through detail responses and compare balances and ledger entries.
- Verify that stored IDs let you recover existing results after a lost create response and prevent duplicate requests.
- Verify that discovery and tracking of pending transactions resume after a service restart.
For production preparation, apply Security Recommendations, Error Handling and Retry, and Idempotency and Duplicate Prevention. Contact Support for environment, asset provisioning, or integration scope questions.