Allo

Vue d'ensemble

Créez des comptes Allo pour vos clients depuis votre propre logiciel, obtenez leur prix et désactivez-les, en tant que partenaire qui revend Allo.

Mis à jour le

Un partenaire désigne ici un revendeur sous contrat Licence à prix réduit : une entreprise qui revend Allo dans son propre produit ou service. L'API Partner permet à un revendeur de créer les comptes Allo de ses clients depuis son propre logiciel, d'en obtenir le prix et de les désactiver.

Une fois le compte créé, ses membres, ses numéros et ses réglages se gèrent dans l'application Allo, comme pour tout client Allo, et non par l'API Partner.

L'API Partner est optionnelle. Le portail partenaire crée et configure les comptes sans code.

Obtenir l'accès partenaire

Le scope PARTNER est accordé manuellement aux revendeurs approuvés, et il ne peut pas être auto-émis. Pour devenir revendeur et recevoir une clé avec le scope PARTNER, consultez le Programme Partenaire ou écrivez à [email protected].

Seuls les partenaires Licence à prix réduit (revendeurs) peuvent créer des comptes, en obtenir le prix et les désactiver. Tout autre partenaire reçoit PARTNER_CONTRACT_CANNOT_PROVISION (ou PARTNER_CANNOT_DEACTIVATE à la désactivation). Un compte qui n'est pas un partenaire activé reçoit PARTNER_ACCESS_REQUIRED.

Authentification

Envoyez votre clé PARTNER dans le header Authorization, sous la forme Api-Key <votre-clé> ou la clé seule. N'utilisez pas Bearer <votre-clé> : Allo lit une valeur Bearer comme un jeton de session utilisateur, et une API key envoyée ainsi renvoie 401.

curl https://api.withallo.com/v2/api/partner/credit \
  -H "Authorization: Api-Key ak_live_your_key_here"

Voir Authentification pour le format du header et les scopes.

Facturation

Chaque compte que vous créez a son propre abonnement au plan Business, qui vous est facturé selon la périodicité choisie (MONTHLY ou YEARLY). Allo débite la période complète à la création du compte, avec votre remise partenaire appliquée. Il n'y a pas de prorata. Allo ne facture jamais votre client : vous facturez vos clients vous-même.

Tous les montants partenaires se paient de la même façon : nouveaux comptes, renouvellements, numéros supplémentaires, sièges des membres et eSIM.

  1. Allo prélève d'abord votre crédit prépayé.
  2. Si le crédit ne couvre pas tout le montant, Allo débite le reste sur la carte de votre compte de facturation.
  3. Si le crédit ne couvre pas le montant et qu'aucune carte n'est enregistrée, la requête échoue avec 402 PARTNER_CREDIT_INSUFFICIENT et rien n'est créé.

Appelez Obtenir le prix d'un compte pour connaître le coût d'un nouveau compte avant de le créer, et Obtenir le crédit prépayé pour vérifier votre solde.

Endpoints

MéthodeCheminDescription
GET/v2/api/partner/accounts/priceObtenir le prix qu'Allo vous facturera pour un nouveau compte
POST/v2/api/partner/accountsCréer un compte, provisionner un numéro, renvoyer une clé dédiée
GET/v2/api/partner/accounts/{id}Obtenir le statut et l'état d'activation d'un compte
DELETE/v2/api/partner/accounts/{id}Désactiver un compte (résilie son abonnement, le compte fonctionne jusqu'à la fin de la période payée)
GET/v2/api/partner/creditObtenir le solde de votre crédit prépayé et vos derniers rechargements