Skip to main content

Les deux surfaces

SurfaceMéthodeHeaderUsage
DashboardJWT BearerAuthorization: Bearer <jwt>Interface web et endpoints console /api/*
API publiqueClé APIx-api-key: <api_key>Endpoints /api/v1/* pour vos intégrations
Pour toute intégration serveur à serveur, utilisez une clé API.

Format de la clé API

Une clé API MsgFlash ressemble à :
msgf_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2
Structure :
  • préfixe msgf_live_
  • 64 caractères hexadécimaux minuscules
La clé complète n’est affichée qu’une seule fois lors de la création.

Utiliser votre clé API

curl https://srv.msgflash.com/api/v1/messages/send \
  -H "x-api-key: msgf_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "to": "+22901000000",
    "type": "text",
    "text": "Bonjour"
  }'
N’utilisez pas Authorization: Bearer <api_key> pour l’API publique. Le backend attend explicitement le header x-api-key.

Créer et révoquer une clé

  1. Connectez-vous à app.msgflash.com
  2. Ouvrez API Keys
  3. Cliquez sur New API Key
  4. Donnez un nom descriptif
  5. Copiez la clé immédiatement
Pour révoquer une clé :
  1. Retournez dans API Keys
  2. Cliquez sur Revoke
  3. Confirmez
La révocation est immédiate.

Nombre de clés par plan

PlanClés API autorisées
Free0
Starter3
Pro5
Plus10

Bonnes pratiques

Une clé par environnement

Utilisez une clé distincte pour la production, le staging et le développement.

Variables d'environnement

Stockez votre clé dans une variable comme MSGFLASH_API_KEY ou dans un gestionnaire de secrets.

Erreurs liées à l’authentification

CodeHTTPDescription
UNAUTHORIZED401Clé manquante, invalide ou révoquée
FORBIDDEN403La clé est valide mais n’a pas accès à la ressource
SUBSCRIPTION_INACTIVE403Le compte n’a plus de souscription exploitable pour l’action demandée
API_RATE_LIMIT_EXCEEDED429Plus de 10 requêtes/seconde sur la même clé
MONTHLY_API_REQUEST_QUOTA_EXCEEDED429Quota mensuel de requêtes API épuisé
Exemple :
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or revoked API key"
  }
}