Kolabo
Le module KolaboApi gère le système de parrainage et de partenariat Kolabo.
Accès : client.kolabo
Sous-modules
client.kolabo.app- Gestion des applications Kolaboclient.kolabo.customer- Clients Kolaboclient.kolabo.partner- Partenaires/Parrains
Applications
app.configure
Configure une application pour Kolabo.
Exemple
const response = await client.kolabo.app.configure("app_slug", {
appId: "app_id",
apiKey: "user_api_key",
name: "Mon App",
revenueRate: 10,
description: "Application de parrainage"
});app.join
Rejoint une application Kolabo.
Exemple
const response = await client.kolabo.app.join("app_slug", {
appId: "app_id",
apiKey: "user_api_key"
});app.list
Liste les applications Kolabo disponibles.
Exemple
const response = await client.kolabo.app.list({
apiKey: "user_api_key"
});app.get
Récupère une application Kolabo.
Exemple
const response = await client.kolabo.app.get("app_slug", {
appId: "app_id",
apiKey: "user_api_key"
});Clients
customer.create
Crée un client Kolabo.
Exemple
const response = await client.kolabo.customer.create({
fullName: "Jean Dupont",
email: "jean@example.com",
phone: "+2250700000000"
});customer.createPartnership
Associe un client à un partenariat.
Exemple
const response = await client.kolabo.customer.createPartnership({
partnershipId: "partnership_id",
customerId: "customer_id"
});Partenaires
partner.signUp
Inscription d’un nouveau partenaire.
Exemple
const response = await client.kolabo.partner.signUp({
fullName: "Marie Martin",
email: "marie@example.com",
phone: "+2250700000000",
sex: "F",
password: "motdepasse"
});partner.check
Vérifie si un partenaire existe.
Exemple
const response = await client.kolabo.partner.check({
phone: "+2250700000000"
});partner.get
Récupère un partenaire par ID.
Exemple
const response = await client.kolabo.partner.get("partner_id", {
apiKey: "partner_api_key"
});partner.editProfile
Modifie le profil d’un partenaire.
Exemple
const response = await client.kolabo.partner.editProfile("partner_id", {
apiKey: "partner_api_key",
fullName: "Marie Martin-Dupont"
});partner.apps
Liste les applications d’un partenaire.
Exemple
const response = await client.kolabo.partner.apps("partner_id", {
apiKey: "partner_api_key"
});partner.listTransactions
Liste les transactions d’un partenaire.
Exemple
const response = await client.kolabo.partner.listTransactions("partner_id", {
apiKey: "partner_api_key",
limit: 20,
type: "REVENUE"
});partner.withdraw
Effectue un retrait pour un partenaire.
Exemple
const response = await client.kolabo.partner.withdraw("partner_id", {
apiKey: "partner_api_key",
amount: 10000,
phone: "+2250700000000",
paymentMethod: "OM_CI"
});partner.delete
Supprime un partenaire.
Exemple
const response = await client.kolabo.partner.delete("partner_id", {
apiKey: "partner_api_key"
});Last updated on