burok-sdk
v1.0.98
Published
SDK officiel pour l'API BUROK - Solution de paiement pour l'Afrique de l'Ouest
Readme
BUROK SDK
SDK officiel TypeScript / JavaScript pour l’API BUROK : wallets, paiements, crypto multichain, abonnements, webhooks, et le reste de la plateforme.
Installation
npm install burok-sdkDémarrage rapide
import { BurokClient } from 'burok-sdk';
const client = new BurokClient({
apiKey: process.env.BUROK_API_KEY!,
baseUrl: 'https://api.burok.app',
autoRefreshToken: true,
});
client.setAuthToken(userJwt);
const session = await client.auth.getSession();Documentation
| Document | Contenu |
|----------|---------|
| ALL_README_TS/README_BUROK_SDK.md | Installation, auth, erreurs, modules principaux |
| ALL_README_TS/crypto/multichain/README_multichain.md | Crypto multichain : sameChain, crossChain, bridge, swap, etc. |
| ALL_README_TS/crypto/multichain/README_same-chain.md | Transferts même chaîne (Solana / EVM, groupes) |
| ALL_README_TS/crypto/multichain/README_cross-chain.md | Transferts cross-chain (quote / execute) |
| ALL_README_TS/crypto/multichain/README_bridge.md | Module pont (/api/crypto/bridge) |
| Autres fichiers sous ALL_README_TS/ | Paiements, QR, parrainage, marketplace, etc. |
La documentation détaillée est découpée par domaine dans ALL_README_TS/ pour rester lisible et à jour.
Exemples crypto (multichain)
// Transfert same-chain Solana
await client.crypto.sameChain.solana({
from_burok_user_id: '...',
to_burok_user_id: '...',
amount: 0.25,
});
// Devis cross-chain
const quote = await client.crypto.crossChain.getQuote({
source_chain_type: 'evm',
destination_chain_type: 'solana',
isBridge: true,
amount: '1000000',
chain: 'base',
from_burok_user_id: '...',
to_burok_user_id: '...',
});
// Pont (même logique serveur, préfixe /bridge)
await client.crypto.bridge.getQuote({ /* mêmes params */ });Prérequis
- Node.js 18+ (ou environnement compatible ES modules selon ton bundler)
- Clé API BUROK (tableau de bord développeur)
- JWT utilisateur pour les opérations sensibles (transferts, profil, etc.)
Licence
MIT
