M-Pesa ist ein mobiltelefonbasierter Geldtransfer-, Finanzierungs- und Mikrofinanzierungsdienst. Der Dienst ermöglicht es Benutzern, Geld einzuzahlen, abzuheben, Geld zu überweisen und Waren und Dienstleistungen (Lipa na M-Pesa) einfach mit einem mobilen Gerät zu bezahlen. Um Entwicklern bei der Implementierung von Mpesa auf ihren Plattformen zu helfen, hat Safaricom die Daraja-API veröffentlicht, eine REST-basierte API, die die Funktionalitäten von Mpesa auf Systementwickler verlagert. Lipa na Mpesa Online ist eine der Funktionalitäten, die von der Daraja-API bereitgestellt werden. Es ist ein Dienst, der verwendet wird, um Mpesa-Transaktionen im Namen des Kunden zu initiieren STK-PUSH. Das bedeutet, dass der Benutzer lediglich die PIN eingeben muss. Es wird unter anderem in E-Commerce- und Rechnungszahlungssystemen eingesetzt.
Erstellen Sie ein Safaricom-Entwicklerkonto
Safaricom kontrolliert alle Operationen bezüglich Mpesa und Daraja API. Für den Zugriff auf die Daraja-API benötigen Sie ein Entwicklerkonto. Die folgenden Schritte erläutern, wie Sie ein Entwicklerkonto erstellen können.
- Weiter zu Safaricom-Entwickler-Website
- Klicken Sie auf die Schaltfläche „Anmelden“ und fahren Sie mit dem Anmeldebereich fort
- Nach der Registrierung wird eine Willkommensnachricht mit weiteren Anweisungen an Ihre E-Mail-Adresse gesendet. In der E-Mail finden Sie einen Bestätigungslink, klicken Sie darauf und Sie werden zu einer Passworteingabeseite weitergeleitet
- Geben Sie Ihr Passwort ein und bestätigen Sie es und klicken Sie dann auf „Anmelden“.
App erstellen
Um die Daraja-API verwenden zu können, benötigen Sie eine App, damit Sie über die erforderlichen Zugriffsschlüssel verfügen. Befolgen Sie diese Schritte, um eine App zu erstellen.
- Klicken Sie im Entwicklerportal in der Navigationsleiste auf „Meine Apps“.
- Klicken Sie auf dieser Seite auf „Neue App hinzufügen“.
- Geben Sie auf der folgenden Seite Ihren bevorzugten App-Namen ein. Überprüf den Lipa na Mpesa-Sandbox und dann auf „App erstellen“
Konfigurieren der Anwendung
Nachdem Sie das Entwicklerkonto und eine App eingerichtet haben, ist es an der Zeit, Ihre Anwendung einzurichten. Implementieren Sie eine REST-API mit dem Express.js-Framework. Ihr Endziel ist es, einen funktionierenden Endpunkt für Lipa na Mpesa online zu implementieren. Um die Kommunikation zu und von der Daraja-API abzuwickeln, können Sie verwenden Axios. Um effektiv mitzumachen, klonen Sie das abgeschlossene Projekt aus GitHub. Um Ihre API zu testen, können Sie verwenden Postman.
Abrufen des Verbraucherschlüssels und des Verbrauchergeheimnisses
Klicken Sie auf der Apps-Seite des Portals auf die neu erstellte App aus dem vorherigen Prozess. Kopieren Sie im Abschnitt Schlüssel den Verbraucherschlüssel und das Verbrauchergeheimnis und fügen Sie sie in Ihre .env Datei jeweils wie unten gezeigt:
//in the .env file
consumer_key = "your consumer key"
consumer_secret = "your consumer secret"
Nachdem Sie den Verbraucherschlüssel und das Verbrauchergeheimnis gespeichert haben, können Sie mit dem nächsten Schritt zum Abrufen eines OAuth-Tokens fortfahren.
Holen Sie sich ein OAuth-Token
Um jeden Aufruf an die Daraja-API zu tätigen, müssen Sie immer ein OAuth-Token bereitstellen. Aus diesem Grund implementieren Sie es als Middleware, die jedes Mal aufgerufen wird, wenn Sie auf einen Endpunkt zugreifen. Die Funktion wird wie folgt sein:
async getOAuthToken(req,res,next){
let consumer_key = process.env.consumer_key;
let consumer_secret = process.env.consumer_secret;
let url = process.env.oauth_token_url;
//form a buffer of the consumer key and secret
let buffer = new Buffer.from(consumer_key+":"+consumer_secret);
let auth = `Basic ${buffer.toString('base64')}`;
try{
let {data} = await axios.get(url,{
"headers":{
"Authorization":auth
}
});
req.token = data['access_token'];
return next();
}catch(err){
return res.send({
success:false,
message:err['response']['statusText']
});
}
};
- Empfang req,res,nächste als Parameter. Da die Funktion als Middleware aufgerufen wird, müssen Sie die entsprechenden Parameter übergeben. req Zugriff auf das Anforderungsobjekt hat, während Rindfleisch Zugriff auf das Response-Objekt hat. weiter wird verwendet, um die nächste Middleware auf diesem bestimmten Endpunkt auszuführen
- Greifen Sie auf die Umgebungsvariablen zu Verbraucher_Schlüssel, Verbraucher_Geheimnis und oauth_token_url
- Erstellen Sie einen Puffer und codieren Sie ihn dann in a base64 Schnur
- Verwenden versuchen, fangen Block für die Kommunikation mit der Daraja-API. Wenn die Anforderung erfolgreich ist, legen Sie das Token für das Anforderungsobjekt fest und führen Sie dann die nächste Middleware aus. Sonst den Fehler zurückgeben
Implementierung von Lipa na M-Pesa online
Nachdem Sie ein Zugriffstoken generiert haben, können Sie nun Ihre Kernfunktionalität implementieren. Da es sich bei Express.js um eine Reihe von Middleware-Aufrufen handelt, implementieren Sie es auch als Middleware. Die Umsetzung erfolgt wie folgt:
async lipaNaMpesaOnline(req,res){
let token = req.token;
let auth = `Bearer ${token}`;
//getting the timestamp
let timestamp = require('../middleware/timestamp').timestamp;
let url = process.env.lipa_na_mpesa_url;
let bs_short_code = process.env.lipa_na_mpesa_shortcode;
let passkey = process.env.lipa_na_mpesa_passkey;
let password = new Buffer.from(`${bs_short_code}${passkey}${timestamp}`).toString('base64');
let transcation_type = "CustomerPayBillOnline";
let amount = "1"; //you can enter any amount
let partyA = "party-sending-funds"; //should follow the format:2547xxxxxxxx
let partyB = process.env.lipa_na_mpesa_shortcode;
let phoneNumber = "party-sending-funds"; //should follow the format:2547xxxxxxxx
let callBackUrl = "your-ngrok-url/mpesa/lipa-na-mpesa-callback";
let accountReference = "lipa-na-mpesa-tutorial";
let transaction_desc = "Testing lipa na mpesa functionality";
try {
let {data} = await axios.post(url,{
"BusinessShortCode":bs_short_code,
"Password":password,
"Timestamp":timestamp,
"TransactionType":transcation_type,
"Amount":amount,
"PartyA":partyA,
"PartyB":partyB,
"PhoneNumber":phoneNumber,
"CallBackURL":callBackUrl,
"AccountReference":accountReference,
"TransactionDesc":transaction_desc
},{
"headers":{
"Authorization":auth
}
}).catch(console.log);
return res.send({
success:true,
message:data
});
}catch(err){
return res.send({
success:false,
message:err['response']['statusText']
});
};
};
Die Implementierung folgt diesen Schritten:
- Greifen Sie auf das Token zu, das wir im Anforderungsobjekt gespeichert haben
- Hängen Sie Bearer vor die Zeichenfolge, um die Autorisierungszeichenfolge zu erstellen
- Holen Sie sich den aktuellen Zeitstempel.
- Rufen Sie die Lipa na Mpesa-URL ab, die als Umgebungsvariable gespeichert ist
- Holen Sie sich Ihren geschäftlichen Funktionscode und Hauptschlüssel. Fahren Sie mit Ihrem fort Anmeldeinformationen testen. Dann kopieren und einfügen Lipa Na Mpesa Online-Shortcode als geschäftliche Kurzwahl zu Ihrer .env Datei-und Lipa Na Mpesa Online-Passkey als Hauptschlüssel
- Rufen Sie das Kennwort ab, das aus einem Puffer generiert wird, der sich aus Geschäftsfunktionscode, Hauptschlüssel und Zeitstempel zusammensetzt. Der Puffer wird dann zu a kodiert base64 Schnur
- Stellen Sie den Transaktionstyp auf ein KundePayBillOnline das ist das einzige, das unterstützt wird. Ändern Sie es nicht
- Stellen Sie den zu zahlenden Betrag ein
- Legen Sie die PartyA fest, die die Telefonnummer ist, die das Geld sendet. Die Telefonnummer sollte die verwenden 2547xxxxxxxxx Format
- Stellen Sie PartyB ein, das ist der geschäftliche Funktionscode
- Legen Sie die Telefonnummer fest, die die Telefonnummer ist, die das Geld sendet. Verwenden Sie das Format wie in PartyA erklärt
- Legen Sie die Rückruf-URL fest. Die Rückruf-URL ist der Ort, an dem die Antwort verarbeitet wird. Sie können verwenden Ngrok
Stellen Sie mit dem Befehl sicher, dass Ihr Server läuft:
npm run dev
Öffnen Sie dann einen weiteren Tab und führen Sie den folgenden Befehl aus:
npm run ngrok
Dadurch werden Sie zu einem bestimmten Link weitergeleitet, z http://78066c1c2d6b.ngrok.io. Kopieren Sie diesen Link und fügen Sie die callBackUrl-Variable ein. Beachten Sie, dass der Link jedes Mal anders ist, wenn Sie den Server stoppen und erneut starten.
- Legen Sie die Kontoreferenz fest, die eine beliebige Zeichenfolge sein kann, die Sie festlegen. Es weist darauf hin, wohin das Geld ausgezahlt wird
- Legen Sie die Transaktionsbeschreibung fest, die beschreibt, wofür die Transaktion bestimmt ist
- Verwenden versuchen, fangen bei der Kommunikation mit der Daraja-API blockieren. Wenn der Prozess erfolgreich ist, geben Sie die Nachricht von der API zurück. Geben Sie andernfalls den Fehler von der API zurück
Lipa na Mpesa Online-Rückruf
Wenn Sie eine Anfrage senden, wird die Antwort von der API über den Rückruf gesendet. Falls Sie einige Datensätze aktualisieren möchten, können Sie sie hier basierend auf der zurückgesendeten Antwort aktualisieren. Einen einfachen Callback implementieren Sie als Methode in der Klasse.
lipaNaMpesaOnlineCallback(req,res){
//Get the transaction description
let message = req.body.Body.stkCallback['ResultDesc'];
return res.send({
success:true,
message
});
};
Rufen Sie die Beschreibung der durchgeführten Transaktion auf oder senden Sie die gesendete Nachricht zurück.
Zusammenfassend
Wenn Sie Ihre App per Push in die Produktion übertragen möchten, müssen Sie die Rückruf-URL in Ihre Serverdomäne ändern, wenn sie online gehostet wird. Nachdem Sie Anmeldeinformationen hinzugefügt haben .env Datei, fügen Sie sie Ihrer hinzu .gitignore -Datei, damit Sie Ihre Anmeldeinformationen nicht preisgeben, wenn Sie Ihr Projekt per Push an GitHub übertragen.
