Comment envoyer des SMS en utilisant les API MTN Developer (MADAPI)

Ce guide explique comment accéder aux API à valeur ajoutée de MTN via le portail développeur MTN (https://developers.mtn.com/). Il vous montre comment obtenir un jeton d'accès développeur et comment utiliser l'API SMS MTN v2 pour envoyer des messages SMS via Ozeki SMS Gateway.

URLs des API

  • https://sandbox.api.mtn.com/oauth/client_credential/accesstoken?grant_type=client_credentials
  • https://api.mtn.com/v2/messages/sms/outbound

Qu'est-ce que le service SMS MTN ?

MTN, en tant qu'opérateur mobile panafricain, propose des services SMS (envoi et réception de SMS) pour ses partenaires commerciaux et ses utilisateurs de téléphonie mobile.

Qu'est-ce que le protocole MADAPI ?

C'est une implémentation protocolaire du service SMS en ligne de MTN.

Qu'est-ce que l'API MADAPI ?

L'API MTN MAD est une API unifiée qui inclut divers microservices indépendants (tels que l'API Mobile Money, l'API SMS et USSD, l'API Marketplace Chenosis, etc.) Ces services sont accessibles par MTN et les fournisseurs partenaires via l'API MAD. Les connexions au service MAD-API sont fournies par Google Apigee via une passerelle API unifiée et un portail d'approvisionnement.

Comment fonctionne l'API MADAPI ?

MADAPI est une plateforme où l'API de messagerie SMS de MTN permet aux développeurs d'intégrer la messagerie SMS dans leurs applications métiers.

Comment s'inscrire sur le portail Madapi Developer

La vidéo suivante vous guidera à travers le processus simplifié d'inscription sur le portail Madapi Developer, où vous pourrez découvrir les possibilités de développement d'API. Découvrez la puissance des API de MTN qui peuvent améliorer vos applications, optimiser la communication et rationaliser vos projets. Suivez-nous pendant que nous démontrons la simplicité et l'efficacité de l'utilisation de l'API SMS MTN v2 en combinaison avec la passerelle SMS Ozeki pour envoyer des messages SMS en toute transparence.

Vidéo 1 - Comment s'inscrire sur le portail Madapi Developer (Tutoriel vidéo)

Pour commencer, vous devez vous inscrire sur le site https://developers.mtn.com/ en cliquant sur le bouton "S'inscrire" dans le coin supérieur droit de la page. Cette inscription vous permettra de créer une application ; il suffit de suivre les étapes d'inscription simples. Suivez ces étapes pour créer votre compte :

sélectionner s'inscrire
Figure 1 - Sélectionner s'inscrire

En cliquant sur le bouton "S'inscrire", une page d'inscription s'affichera, où il sera nécessaire de renseigner des informations personnelles, comme votre nom et votre adresse e-mail. Assurez-vous d'utiliser une adresse e-mail valide, car elle sera utilisée pour la communication et la vérification. Ensuite, cliquez sur le bouton "Suivant". Ajoutez également votre nom de famille. Sélectionnez à nouveau le bouton "Suivant".

définir le nom et l'adresse e-mail
Figure 2 - Définir le nom et l'adresse e-mail

Choisissez un mot de passe robuste et unique pour votre compte, combinant des majuscules, des minuscules, des chiffres et des caractères spéciaux pour des raisons de sécurité. Une fois votre mot de passe créé, confirmez-le en le saisissant à nouveau, puis cliquez sur le bouton "Suivant" pour passer à l'étape suivante.

ajouter un mot de passe
Figure 3 - Ajouter un mot de passe

Pour continuer, sélectionnez votre pays de résidence parmi les options proposées, puis cliquez sur le bouton "Suivant". Cela vous mènera à l'étape suivante du processus d'inscription. Lisez les conditions générales, la politique de confidentialité et tout autre accord pertinent fourni par MTN. Si vous acceptez leurs conditions, cochez la case appropriée pour donner votre consentement.

sélectionner le pays
Figure 4 - Sélectionner le pays

Après avoir rempli le formulaire d'inscription, un e-mail sera envoyé à l'adresse que vous avez fournie. Cliquez sur le lien de vérification dans cet e-mail pour confirmer votre compte et l'activer. Vous devrez entrer un code d'authentification que vous recevrez via votre application Google Authenticator. Si vous ne disposez pas encore de cette application, téléchargez-la depuis une plateforme de distribution numérique comme Google Play ou l'App Store.

vérifier l'adresse e-mail
Figure 5 - Vérifier l'adresse e-mail

Téléchargez Google Authenticator sur votre téléphone Android depuis Google Play ou l'App Store si vous utilisez un appareil iOS.

installer google authenticator
Figure 6 - Installer Google Authenticator

Maintenant, vous devez associer un compte Google Authenticator pour pouvoir authentifier votre compte MTN. Appuyez sur le bouton "+" ou "Ajouter" dans l'application pour configurer un nouveau compte. Entrez les détails fournis dans l'e-mail de vérification de MTN. Vous aurez deux options pour ajouter votre compte MTN : Si MTN fournit un code QR, utilisez l'application Google Authenticator pour le scanner. Cela configurera automatiquement le compte dans l'application. Sinon, vous pouvez saisir manuellement les informations du compte.

ajouter un compte dans google authenticator
Figure 7 - Ajouter un compte dans Google Authenticator

Vous devrez entrer le nom du compte, votre e-mail MTN et la clé secrète ou le code d'authentification fourni par MTN. Choisissez un nom pour identifier votre compte MTN dans l'application Google Authenticator. Entrez l'adresse e-mail associée à votre compte MTN. Collez votre clé secrète, un code unique fourni par MTN spécifiquement pour activer l'authentification à deux facteurs (2FA) avec Google Authenticator.

détails du compte dans google authenticator
Figure 8 - Détails du compte dans Google Authenticator

Une fois que vous avez ajouté le compte à Google Authenticator, l'application commencera à générer des mots de passe à usage unique (OTP) à six chiffres qui changent toutes les 30 secondes. Retournez à l'e-mail de vérification de MTN, où vous trouverez un champ pour entrer le code de vérification généré par l'application Google Authenticator. Entrez le code actuel de l'application Google Authenticator dans le champ désigné de l'e-mail de vérification. Cliquez sur le bouton "Authentifier" pour terminer le processus de configuration. En cliquant sur le bouton "Authentifier", le portail développeur de MTN s'affichera. Vous verrez une page "Mon Profil", où vous pourrez personnaliser votre compte et consulter les détails du compte précédemment configurés.

activer l'authentification à deux facteurs
Figure 9 - Activer l'authentification à deux facteurs

Comment se connecter avec Google Authenticator

Pour vous connecter à votre compte, chargez la page https://developers.mtn.com/ et entrez votre adresse e-mail et votre mot de passe dans les champs correspondants, puis cliquez sur le bouton "Se connecter" en bas.

connexion au portail développeur
Figure 10 - Connexion au portail développeur

Ensuite, il est nécessaire d'entrer le code d'authentification à deux facteurs (2FA), fourni par l'application Google Authenticator. Entrez le code reçu, puis cliquez sur le bouton "Authentifier" pour finaliser le processus de connexion.

authentification à deux facteurs
Figure 11 - Authentification à deux facteurs

Comment créer une application

Dans cette courte vidéo, vous découvrirez comment créer une application en utilisant l'API SMS MTN v2, en collaboration avec la passerelle SMS Ozeki, vous permettant d'envoyer des SMS facilement. Suivez le guide étape par étape pour constater l'efficacité et la simplicité d'intégration de ces outils dans vos projets.

Vidéo 2 - Comment créer une application

Pour commencer, cliquez sur le bouton "Créer une application" en haut à droite de la page. Ce bouton lancera le processus de création d'application et vous permettra de parcourir les nombreuses options de développement disponibles sur la plateforme MTN.

créer une application
Figure 12 - Créer une application

Vous devez entrer des détails essentiels concernant votre application. Ces informations sont nécessaires pour configurer votre application sur la plateforme développeur MTN. Choisissez un nom unique pour votre application. Ce nom servira à identifier votre application dans le portail développeur. Il est optionnel d'ajouter une brève description de l'objectif et des fonctionnalités de votre application. Ensuite, cliquez sur le bouton "Sélectionner les pays".

définir les détails de l'application
Figure 13 - Définir les détails de l'application

Après avoir saisi les détails nécessaires concernant votre application, l'étape suivante consiste à sélectionner le pays d'où vous venez et que vous souhaitez associer à votre application. Cette sélection aide MTN à personnaliser et optimiser les services et API disponibles pour votre application en fonction des exigences et réglementations locales.

sélectionner un pays
Figure 14 - Sélectionner un pays

Maintenant, choisissez l'option "SMS V2" dans la liste des produits. Cliquez sur le bouton "+" situé en bas à droite de la description du produit. En cliquant dessus, vous créerez cette interface SMS avec support de rappel.

ajouter l'interface SMS V2
Figure 15 - Ajouter l'interface SMS V2

Pour lancer le processus de création de l'application, trouvez le bouton "Créer l'application", puis cliquez dessus.

créer l'application
Figure 16 - Créer l'application

Si l'application a été créée avec succès, vous recevrez une notification de confirmation. Ensuite, vous serez redirigé vers une page de résumé présentant un aperçu de vos applications approuvées. Sur cette page, vous trouverez des détails sur vos applications. Si certaines applications n'ont pas été installées avec succès, elles figureront sous le titre "Applications révoquées".

application madapi créée
Figure 17 - Application Madapi créée

Comment ajouter le service SMS V2 à votre application

Maintenant, nous expliquerons comment ajouter le service SMS V2 à votre application. Pour ajouter le service SMS V2 à votre application, vous devez modifier les détails de l'application dans la page "Mes applications", sous l'onglet "Applications approuvées".

modifier l'application
Figure 18 - Modifier l'application

Apportez des modifications aux détails de l'application. Changez le nom de votre application. Modifiez la description pour mieux refléter son objectif et ses fonctionnalités. Ajoutez ou modifiez les URL vers lesquelles les utilisateurs doivent être redirigés. Cliquez sur le bouton "Modifier" pour apporter des changements. Après avoir effectué les modifications, vérifiez leur exactitude, puis cliquez sur "Suivant" pour passer à l'étape suivante.

modifier les détails de l'application
Figure 19 - Modifier les détails de l'application

Après avoir complété ces étapes, cliquez sur la coche dans le cercle noir. Le service SMS V2 sera ajouté avec succès à votre application. Vous pouvez désormais exploiter les capacités SMS de MTN pour améliorer la communication.

ajouter le service SMS V2 à votre application
Figure 20 - Ajouter le service SMS V2 à votre application

Comment copier la clé client et le secret de production dans Ozeki 10

Dans la vidéo à venir, nous allons démontrer étape par étape le processus de copie de la clé client et du secret de production dans Ozeki 10. Cette procédure permet l'intégration transparente entre les deux plateformes, vous permettant d'exploiter les fonctionnalités des API de MTN et d'Ozeki 10 pour améliorer vos capacités de messagerie et rationaliser la communication avec vos utilisateurs.

Vidéo 3 - Comment copier la clé client et le secret de production dans Ozeki 10 (Tutoriel vidéo)

Pour commencer, connectez-vous à votre compte Ozeki SMS Gateway. Si vous n'avez pas encore de compte, vous pouvez télécharger le logiciel depuis le site https://ozeki.hu/. Une fois votre compte prêt, ouvrez Ozeki Gateway sur Ozeki Desktop pour accéder à l'interface de gestion de la passerelle et configurer vos paramètres de messagerie. Cliquez sur le lien "Ajouter une nouvelle connexion..." dans le panneau Connexions ou choisissez l'icône "Connecter" dans la barre d'outils.

ajouter une nouvelle connexion
Figure 21 - Ajouter une nouvelle connexion

En cliquant dessus, une liste apparaîtra, contenant diverses options de clients pouvant être installés. Trouvez le "Client MTN MADAPI" qui vous permet de créer des requêtes SMS sortantes en utilisant l'API SMS V2 de MTN, puis cliquez sur le lien "Installer".

installer le client madapi
Figure 22 - Installer le client Madapi

L'installation du client MTN MADAPI affichera une page où vous devrez entrer certains détails pour configurer la connexion. Chargez le portail des développeurs de MNP et copiez la clé consommateur et les codes secrets.

copier la clé et le secret
Figure 23 - Copier la clé et le secret

Collez ces codes dans les champs désignés de l'Ozeki SMS Gateway. Une fois les codes collés dans les sections appropriées, faites défiler jusqu'en bas de la page. Pour enregistrer les modifications et confirmer l'intégration, cliquez sur le bouton "Ok". L'enregistrement des codes avec le bouton "Ok" garantira que l'Ozeki SMS Gateway est maintenant correctement configuré pour fonctionner avec les API de MTN.

coller la clé et le secret
Figure 24 - Coller la clé et le secret

Comment vérifier que vous avez reçu votre jeton d'accès

Après avoir enregistré les détails dans le panneau de contrôle d'Ozeki SMS Gateway, accédez à l'onglet "Événements". Vous y trouverez un bouton coulissant sur le côté gauche du panneau. Basculez le bouton coulissant en position verte. Si la configuration a réussi, vous recevrez une notification intitulée "Jeton d'accès" dans le panneau Événements. Cela indique que l'intégration entre les API de MTN et Ozeki SMS Gateway est maintenant active, et votre application peut accéder au jeton d'authentification nécessaire pour communiquer de manière transparente avec les services de MTN.

jeton d'accès reçu
Figure 25 - Jeton d'accès reçu

Comment envoyer un SMS test et comment vérifier les journaux

Dans la vidéo à venir, nous fournirons un guide étape par étape pour envoyer un SMS test en utilisant le service SMS intégré de MTN via l'Ozeki SMS Gateway. Nous vous guiderons à travers le processus de composition et d'envoi du message test, vous assurant de pouvoir communiquer efficacement avec vos destinataires prévus. De plus, nous vous montrerons comment vérifier les journaux dans l'Ozeki SMS Gateway pour surveiller l'état et les détails de livraison des SMS envoyés.

Vidéo 4 - Comment envoyer un SMS test et comment vérifier les journaux (Tutoriel vidéo)

Comme première étape, connectez-vous à votre compte Ozeki SMS Gateway et chargez la page d'accueil d'Ozeki. Sélectionnez la connexion MNT_MADAPI_client. Ouvrez l'onglet "Test" dans les détails du MNT_MADAPI_client. Là, vous pouvez créer un message SMS. Pour la création, fournissez le numéro de téléphone du destinataire dans le champ approprié, puis entrez le texte du message dans le champ SMS.

créer un message sms test
Figure 26 - Créer un message SMS test

Après avoir entré ces données, cliquez sur le bouton "Envoyer".

envoyer un message test
Figure 27 - Envoyer un message test

En ouvrant l'onglet Événements dans l'Ozeki SMS Gateway, vous pourrez voir l'état du message envoyé. Si le message a été envoyé avec succès, vous recevrez une notification intitulée "Initialisé avec succès." Cette notification confirme que le SMS a été livré au destinataire sans aucun problème.

message envoyé
Figure 28 - Message envoyé

Le guide fournit des instructions étape par étape sur la façon d'utiliser les API MTN Developer (MADAPI) en connexion avec la passerelle SMS Ozeki pour envoyer des messages SMS de manière transparente. En suivant le guide, les développeurs peuvent accéder aux API à valeur ajoutée de MTN via le portail développeur MTN, obtenir un jeton d'accès développeur et utiliser l'API SMS MTN v2 pour envoyer des messages SMS. Globalement, la combinaison des API MTN Developer et de la passerelle SMS Ozeki offre aux développeurs une solution utile et fiable pour intégrer la messagerie SMS dans leurs applications, permettant une communication efficace et améliorant l'expérience utilisateur.

More information