Wie man SMS mit den MTN Developer APIs (MADAPI) versendet

Diese Anleitung erklärt, wie Sie auf die MTN Value-Added-APIs über das MTN Developer-Portal (https://developers.mtn.com/) zugreifen können. Sie zeigt Ihnen, wie Sie einen Developer-Zugriffstoken erhalten und wie Sie die MTN SMS API v2 verwenden, um SMS-Nachrichten mit dem Ozeki SMS Gateway zu versenden.

API-URLs

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

Was ist der MTN SMS-Service?

MTN, als panafrikanischer Mobilfunkanbieter, bietet SMS-Dienste (SMS-Versand und -empfang) für seine Geschäftspartner und Mobiltelefonnutzer an.

Was ist das MADAPI-Protokoll?

Es ist eine Protokollimplementierung des MTN Online-SMS-Services.

Was ist die MADAPI-API?

Die MTN MAD API ist eine einheitliche API, die verschiedene unabhängige Microservices (wie Mobile Money API, SMS- und USSD-API, Chenosis Marketplace API usw.) umfasst. Diese Dienste werden von MTN und Partneranbietern über die MAD API genutzt. MAD-API-Serviceverbindungen werden von Google Apigee über ein einheitliches API- Gateway und Bereitstellungsportal bereitgestellt.

Wie funktioniert die MADAPI-API?

MADAPI ist eine Plattform, auf der die SMS Messaging API von MTN Entwicklern ermöglicht, SMS-Nachrichten in ihre Geschäftsanwendungen zu integrieren.

Wie man sich im Madapi Developer Portal registriert

Das folgende Video führt Sie durch den nahtlosen Prozess der Registrierung im Madapi Developer Portal, wo Sie die Möglichkeiten der API-Entwicklung kennenlernen können. Entdecken Sie die Kraft der MTN-APIs, die Ihre Anwendungen verbessern, die Kommunikation optimieren und Ihre Projekte vereinfachen können. Folgen Sie uns, während wir die Einfachheit und Effektivität der Verwendung der MTN SMS API v2 in Kombination mit dem Ozeki SMS Gateway demonstrieren, um nahtlos SMS-Nachrichten zu versenden.

Video 1 - Wie man sich im Madapi Developer Portal registriert (Video-Tutorial)

Um den Prozess zu starten, müssen Sie sich auf der Website https://developers.mtn.com/ registrieren, indem Sie auf den "Registrieren"-Button in der oberen rechten Ecke der Seite klicken. Diese Registrierung ermöglicht es Ihnen, eine App zu erstellen; folgen Sie einfach den unkomplizierten Registrierungsschritten. Folgen Sie diesen Schritten, um Ihr Konto zu erstellen:

Registrierung auswählen
Abbildung 1 - Registrierung auswählen

Durch Klicken auf den "Registrieren"-Button erscheint eine Registrierungsseite, auf der persönliche Daten wie Name und E-Mail-Adresse eingegeben werden müssen. Stellen Sie sicher, dass Sie eine gültige E-Mail-Adresse verwenden, da diese für die Kommunikation und Verifizierung verwendet wird. Danach klicken Sie auf den "Weiter"-Button. Fügen Sie auch Ihren Nachnamen hinzu. Wählen Sie erneut den "Weiter"-Button.

Name und E-Mail-Adresse definieren
Abbildung 2 - Name und E-Mail-Adresse definieren

Wählen Sie ein starkes, einzigartiges Passwort für Ihr Konto, das Groß- und Kleinbuchstaben, Zahlen und Sonderzeichen kombiniert, um die Sicherheit zu gewährleisten. Wenn Sie Ihr Passwort erstellt haben, bestätigen Sie es, indem Sie es erneut eingeben, und klicken Sie dann auf den "Weiter"-Button, um zum nächsten Schritt zu gelangen.

Passwort hinzufügen
Abbildung 3 - Passwort hinzufügen

Um fortzufahren, wählen Sie Ihr Wohnsitzland aus den bereitgestellten Optionen aus, und sobald Sie Ihre Auswahl getroffen haben, klicken Sie auf den "Weiter"-Button. Dies bringt Sie zur nächsten Stufe des Registrierungsprozesses. Lesen Sie die Allgemeinen Geschäftsbedingungen, die Datenschutzrichtlinie und alle anderen relevanten Vereinbarungen von MTN durch. Wenn Sie mit den Bedingungen einverstanden sind, setzen Sie ein Häkchen in das entsprechende Feld, um Ihre Zustimmung zu geben.

Land auswählen
Abbildung 4 - Land auswählen

Nach Abschluss des Registrierungsformulars wird eine E-Mail an die von Ihnen angegebene Adresse gesendet. Klicken Sie auf den Bestätigungslink in dieser E-Mail, um Ihr Konto zu bestätigen und zu aktivieren. Sie müssen einen Authentifizierungscode eingeben, den Sie über Ihre Google Authenticator-App erhalten. Wenn Sie diese App noch nicht haben, laden Sie sie von einer digitalen Vertriebsplattform für Software, wie Google Play oder App Store, herunter.

E-Mail-Adresse bestätigen
Abbildung 5 - E-Mail-Adresse bestätigen

Laden Sie den Google Authenticator auf Ihr Android-Handy von Google Play oder App Store herunter, wenn Sie ein iOS-Gerät verwenden.

Google Authenticator installieren
Abbildung 6 - Google Authenticator installieren

Nun müssen Sie ein Google Authenticator-Konto zuweisen, um Ihr MTN-Konto authentifizieren zu können. Tippen Sie auf den "+"- oder "Hinzufügen"-Button innerhalb der App, um ein neues Konto einzurichten. Geben Sie die in der Bestätigungs-E-Mail von MTN bereitgestellten Daten ein. Sie haben zwei Möglichkeiten, Ihr MTN-Konto hinzuzufügen: Falls MTN einen QR-Code bereitstellt, verwenden Sie die Google Authenticator-App, um diesen zu scannen. Dadurch wird das Konto automatisch in der App eingerichtet. Oder, falls kein QR-Code vorhanden ist, können Sie die Kontoinformationen manuell eingeben.

Konto in Google Authenticator hinzufügen
Abbildung 7 - Konto in Google Authenticator hinzufügen

Sie müssen den Kontonamen, Ihre MTN-Konto-E-Mail und den von MTN bereitgestellten geheimen Schlüssel oder Authentifizierungscode eingeben. Wählen Sie einen Namen, um Ihr MTN-Konto innerhalb der Google Authenticator-App zu identifizieren. Geben Sie die mit Ihrem MTN-Konto verknüpfte E-Mail-Adresse ein. Fügen Sie Ihren geheimen Schlüssel ein, einen eindeutigen Code, der von MTN speziell für die Zwei-Faktor-Authentifizierung (2FA) mit Google Authenticator bereitgestellt wird.

Kontodetails in Google Authenticator
Abbildung 8 - Kontodetails in Google Authenticator

Sobald Sie das Konto zu Google Authenticator hinzugefügt haben, generiert die App sechsstellige Einmalpasswörter (OTPs), die sich alle 30 Sekunden ändern. Kehren Sie zur Bestätigungs-E-Mail von MTN zurück, wo Sie ein Feld finden sollten, um den von der Google Authenticator-App generierten Bestätigungscode einzugeben. Geben Sie den aktuellen Code aus der Google Authenticator-App in das vorgesehene Feld in der Bestätigungs-E-Mail ein. Klicken Sie auf den "Authentifizieren"-Button, um den Einrichtungsprozess abzuschließen. Durch Klicken auf den "Authentifizieren"-Button erscheint das MTN Developer Portal. Dort sehen Sie eine "Mein Profil"-Seite, auf der Sie Ihr Konto personalisieren und die zuvor eingerichteten Kontodetails einsehen können.

Zwei-Faktor-Authentifizierung aktivieren
Abbildung 9 - Zwei-Faktor-Authentifizierung aktivieren

Anmeldung mit Google Authenticator

Um sich in Ihrem Konto anzumelden, laden Sie die Seite https://developers.mtn.com/ und geben Sie Ihre E-Mail-Adresse und Ihr Passwort in die entsprechenden Felder ein. Klicken Sie dann auf die Schaltfläche "Anmelden" am unteren Rand.

Anmeldung im Entwicklerportal
Abbildung 10 - Anmeldung im Entwicklerportal

Danach müssen Sie den 2FA-Authentifizierungscode eingeben, der von der Google Authenticator App bereitgestellt wird. Geben Sie das angezeigte Passwort ein und klicken Sie dann auf die Schaltfläche "Authentifizieren", um den Anmeldevorgang abzuschließen.

Zwei-Faktor-Authentifizierung
Abbildung 11 - Zwei-Faktor-Authentifizierung

Erstellung einer App

In diesem kurzen Video erfahren Sie, wie Sie eine App mit der MTN SMS API v2 erstellen können, in Zusammenarbeit mit dem Ozeki SMS Gateway, um SMS-Nachrichten nahtlos zu versenden. Folgen Sie der Schritt-für-Schritt-Anleitung, um die Effektivität und Benutzerfreundlichkeit der Integration dieser Tools in Ihre Projekte zu sehen.

Video 2 - Erstellung einer App

Klicken Sie zunächst auf die Schaltfläche "App erstellen" in der oberen rechten Ecke der Seite. Diese Schaltfläche startet den App-Erstellungsprozess und ermöglicht Ihnen, die zahlreichen Entwicklungsoptionen der MTN-Entwicklerplattform zu durchsuchen.

App erstellen
Abbildung 12 - App erstellen

Sie müssen einige grundlegende Details zur App eingeben. Diese Details sind notwendig, um Ihre App innerhalb der MTN-Entwicklerplattform einzurichten und zu konfigurieren. Wählen Sie einen eindeutigen Namen für Ihre App. Dieser Name wird zur Identifizierung Ihrer Anwendung im Entwicklerportal verwendet. Es ist optional, eine kurze Beschreibung des Zwecks und der Funktionalität Ihrer App hinzuzufügen. Klicken Sie anschließend auf die Schaltfläche "Länder auswählen".

App-Details definieren
Abbildung 13 - App-Details definieren

Nachdem Sie die notwendigen Details zu Ihrer App eingegeben haben, besteht der nächste Schritt darin, das Land auszuwählen, aus dem Sie stammen und dem Sie Ihre App zuordnen möchten. Diese Auswahl hilft MTN, die Dienste und APIs, die für Ihre App verfügbar sind, basierend auf den spezifischen Anforderungen und Vorschriften der Region anzupassen und zu optimieren.

Land auswählen
Abbildung 14 - Land auswählen

Wählen Sie nun die Option MTN SMS V2 aus der Liste der Produkte aus. Klicken Sie auf die "+"-Schaltfläche in der unteren rechten Ecke der Produktbeschreibung. Durch einen Klick darauf wird diese SMS-Schnittstelle mit Callback-Unterstützung erstellt.

SMS V2-Schnittstelle hinzufügen
Abbildung 15 - SMS V2-Schnittstelle hinzufügen

Um den App-Erstellungsprozess zu starten, suchen Sie die Schaltfläche "App erstellen" und klicken Sie darauf.

App erstellen
Abbildung 16 - App erstellen

Wenn die App erfolgreich erstellt wurde, erhalten Sie eine Benachrichtigung über die Erstellung. Anschließend werden Sie zu einer Übersichtsseite weitergeleitet, die eine Zusammenfassung Ihrer genehmigten Apps bietet. Auf der Übersichtsseite finden Sie einige Details zu den Apps. Falls Sie Apps haben, die nicht erfolgreich installiert wurden, werden diese unter dem Titel "Widerrufene Apps" aufgelistet.

Madapi-App erstellt
Abbildung 17 - Madapi-App erstellt

Hinzufügen des SMS V2-Dienstes zu Ihrer App

Nun erklären wir, wie Sie den SMS V2-Dienst zu Ihrer App hinzufügen können. Um den SMS V2- Dienst zu Ihrer App hinzuzufügen, müssen Sie die App-Details auf der Seite "Meine Apps" bearbeiten, unter dem Tab "Genehmigte Apps".

App bearbeiten
Abbildung 18 - App bearbeiten

Nehmen Sie Änderungen an den App-Details vor. Ändern Sie den Namen Ihrer App. Passen Sie die Beschreibung Ihrer App an, um deren Zweck und Funktionalität besser widerzuspiegeln. Fügen Sie URLs hinzu oder ändern Sie diese, zu denen Benutzer weitergeleitet werden sollen. Klicken Sie auf die Schaltfläche "Bearbeiten", um die App zu ändern. Nachdem Sie die Änderungen vorgenommen haben, überprüfen Sie deren Richtigkeit und klicken Sie dann auf die Schaltfläche "Weiter", um zum nächsten Schritt fortzufahren.

App-Details ändern
Abbildung 19 - App-Details ändern

Nach Abschluss dieser Schritte klicken Sie auf das Häkchen im schwarzen Kreis. Der SMS V2- Dienst wird erfolgreich zu Ihrer App hinzugefügt. Sie können nun die SMS-Funktionen von MTN nutzen, um die Kommunikation zu verbessern.

SMS V2-Dienst zu Ihrer App hinzufügen
Abbildung 20 - SMS V2-Dienst zu Ihrer App hinzufügen

Wie man den Kundenschlüssel und das Produktionsgeheimnis in Ozeki 10 kopiert

Im folgenden Video zeigen wir Ihnen Schritt für Schritt, wie Sie den Kundenschlüssel und das Produktionsgeheimnis in Ozeki 10 kopieren. Dieser Vorgang ermöglicht die nahtlose Integration zwischen den beiden Plattformen, sodass Sie die Funktionen der MTN-APIs und Ozeki 10 nutzen können, um Ihre Messaging-Fähigkeiten zu verbessern und die Kommunikation mit Ihren Benutzern zu optimieren.

Video 3 - Wie man den Kundenschlüssel und das Produktionsgeheimnis in Ozeki 10 kopiert (Video-Tutorial)

Melden Sie sich zunächst in Ihrem Ozeki SMS Gateway-Konto an. Falls Sie noch kein Konto haben, können Sie die Software von der https://ozeki.hu/-Website herunterladen. Sobald Ihr Konto bereit ist, öffnen Sie das Ozeki Gateway auf dem Ozeki Desktop, um auf die Management-Oberfläche des Gateways zuzugreifen und Ihre Messaging-Einstellungen zu konfigurieren. Klicken Sie auf den Link "Neue Verbindung hinzufügen..." im Verbindungs-Panel oder wählen Sie das "Verbinden"-Symbol in der Toolbar.

Neue Verbindung hinzufügen
Abbildung 21 - Neue Verbindung hinzufügen

Durch Anklicken erscheint eine Liste mit verschiedenen Client-Optionen, die installiert werden können. Suchen Sie den "MTN MADAPI-Client", der Ihnen ermöglicht, ausgehende SMS-Anfragen mit der MTN SMS V2 API zu erstellen, und klicken Sie dann auf den "Installieren"-Link.

Madapi-Client installieren
Abbildung 22 - Madapi-Client installieren

Bei der Installation des MTN MADAPI-Clients erscheint eine Seite, auf der Sie einige Details eingeben müssen, um die Verbindung einzurichten. Laden Sie das MNP-Entwicklerportal und kopieren Sie den Consumer Key und die Secret Codes.

Schlüssel und Geheimnis kopieren
Abbildung 23 - Schlüssel und Geheimnis kopieren

Fügen Sie diese Codes in die entsprechenden Felder im Ozeki SMS Gateway ein. Nachdem Sie die Codes in die entsprechenden Abschnitte eingefügt haben, scrollen Sie zum unteren Ende der Seite. Um die Änderungen zu speichern und die Integration zu bestätigen, klicken Sie auf die Schaltfläche "OK". Das Speichern der Codes mit der "OK"-Schaltfläche stellt sicher, dass das Ozeki SMS Gateway nun korrekt für die Arbeit mit den MTN-APIs konfiguriert ist.

Schlüssel und Geheimnis einfügen
Abbildung 24 - Schlüssel und Geheimnis einfügen

Wie Sie überprüfen können, ob Sie Ihr Zugriffstoken erhalten haben

Nachdem Sie die Details im Ozeki SMS Gateway-Control-Panel gespeichert haben, navigieren Sie zum "Ereignisse"-Tab. Hier finden Sie einen Schieberegler auf der linken Seite des Panels. Schalten Sie den Schieberegler in die grüne Position. Wenn die Einrichtung erfolgreich war, erhalten Sie eine Benachrichtigung mit der Bezeichnung "Zugriffstoken" im Ereignis-Panel. Dies zeigt an, dass die Integration zwischen den MTN-APIs und dem Ozeki SMS Gateway nun aktiv ist und Ihre App das erforderliche Authentifizierungstoken für die nahtlose Kommunikation mit den MTN-Diensten abrufen kann.

Zugriffstoken erhalten
Abbildung 25 - Zugriffstoken erhalten

Wie Sie eine Test-SMS senden und die Protokolle überprüfen

Im folgenden Video zeigen wir Ihnen Schritt für Schritt, wie Sie eine Test-SMS über den integrierten MTN-SMS-Dienst über das Ozeki SMS Gateway senden. Wir führen Sie durch den Prozess des Verfassens und Versendens der Testnachricht, damit Sie effektiv mit Ihren Empfängern kommunizieren können. Zudem zeigen wir Ihnen, wie Sie die Protokolle im Ozeki SMS Gateway überprüfen können, um den Status und die Lieferdetails der gesendeten SMS-Nachrichten zu überwachen.

Video 4 - Wie Sie eine Test-SMS senden und die Protokolle überprüfen (Video-Tutorial)

Melden Sie sich zunächst in Ihrem Ozeki SMS Gateway-Konto an und laden Sie die Ozeki Home-Seite. Wählen Sie die MNT_MADAPI_client-Verbindung. Öffnen Sie den "Test"-Tab in den MNT_MADAPI_client-Details. Dort können Sie eine SMS-Nachricht erstellen. Geben Sie dazu die Telefonnummer des Empfängers in das entsprechende Feld ein und fügen Sie den Text der Nachricht in das SMS-Feld ein.

Test-SMS-Nachricht erstellen
Abbildung 26 - Test-SMS-Nachricht erstellen

Nachdem Sie diese Daten eingegeben haben, klicken Sie auf die Schaltfläche "Senden".

Testnachricht senden
Abbildung 27 - Testnachricht senden

Wenn Sie den Ereignis-Tab im Ozeki SMS Gateway öffnen, können Sie den Status der gesendeten Nachricht einsehen. Wenn die Nachricht erfolgreich gesendet wurde, erhalten Sie eine Benachrichtigung mit der Bezeichnung "Erfolgreich initialisiert". Diese Benachrichtigung bestätigt, dass die SMS ohne Probleme an den Empfänger zugestellt wurde.

Nachricht gesendet
Abbildung 28 - Nachricht gesendet

Zusammenfassung

Die Anleitung bietet Schritt-für-Schritt-Anweisungen zur Verwendung der MTN Developer APIs (MADAPI) in Verbindung mit dem Ozeki SMS Gateway, um nahtlos SMS-Nachrichten zu versenden. Durch Befolgen der Anleitung können Entwickler über das MTN Developer Portal auf die MTN Value-Added-APIs zugreifen, ein Entwickler-Access-Token erhalten und die MTN SMS API v2 zum Versenden von SMS-Nachrichten nutzen. Insgesamt bietet die Kombination aus MTN Developer APIs und Ozeki SMS Gateway Entwicklern eine nützliche und zuverlässige Lösung zur Integration von SMS-Nachrichten in ihre Anwendungen, was eine effiziente Kommunikation ermöglicht und die Benutzererfahrung verbessert.

More information