M-Pesa er en mobiltelefonbaseret pengeoverførsels-, finansierings- og mikrofinansieringstjeneste. Tjenesten giver brugerne mulighed for nemt at indbetale, hæve, overføre penge og betale for varer og tjenester (Lipa na M-Pesa) med en mobilenhed. For at hjælpe udviklere med at implementere Mpesa på deres platforme udgav Safaricom Daraja API, en REST-baseret API, der flytter Mpesas funktionalitet til systemudviklere. Lipa na Mpesa Online er en af funktionerne leveret af Daraja API. Det er en tjeneste, der bruges til at starte Mpesa-transaktioner på vegne af den kunde, der bruger STK-PUSH. Det betyder, at brugeren kun skal indtaste PIN-koden. Det anvendes blandt andet i e-handel og regningsbetalingssystemer.
Opret en Safaricom-udviklerkonto
Safaricom kontrollerer alle operationer vedrørende Mpesa og Daraja API. For at du kan få adgang til Daraja API, skal du have en udviklerkonto. De følgende trin forklarer, hvordan du kan oprette en udviklerkonto.
- Fortsæt til Safaricom Developer hjemmeside
- Klik på knappen 'Tilmeld', og fortsæt til tilmeldingssektionen
- Efter tilmelding sendes en velkomstbesked med yderligere instruktioner til din e-mailadresse. I e-mailen finder du et bekræftelseslink, klik på det, og det vil dirigere dig til en adgangskodeindtastningsside
- Indtast din adgangskode og bekræft den, og klik derefter på 'Login'
Opret en app
For at kunne bruge Daraja API'en skal du have en app, så du har de nødvendige adgangsnøgler. Følg disse trin for at oprette en app.
- Klik på 'Mine apps' på navigeringslinjen på udviklerportalen.
- På den side skal du klikke på 'Tilføj en ny app'
- Indtast dit foretrukne appnavn på siden, der følger. Tjek Lipa na Mpesa sandkasse og klik derefter på 'Opret app'
Konfiguration af applikationen
Efter at have konfigureret udviklerkontoen og en app, er det tid til at konfigurere din applikation. Implementer en REST API med Express.js framework. Dit slutmål er at implementere et fungerende slutpunkt for Lipa na Mpesa online. For at håndtere kommunikation til og fra Daraja API kan du bruge Axios. For at følge med effektivt skal du klone det afsluttede projekt fra GitHub. For at teste din API kan du bruge Postman.
Indhentning af forbrugernøgle og forbrugerhemmelighed
På portalens apps-side skal du klikke på den nyoprettede app fra den forrige proces. I nøgleafsnittet skal du kopiere forbrugernøglen og forbrugerhemmeligheden og indsætte dem i din .env fil som vist nedenfor:
//in the .env file
consumer_key = "your consumer key"
consumer_secret = "your consumer secret"
Når du har gemt forbrugernøglen og forbrugerhemmeligheden, er du indstillet til at fortsætte til næste trin med at få et OAuth-token.
Få et OAuth-token
For at foretage hvert opkald til Daraja API'en skal du altid levere et OAuth-token. Af denne grund vil du implementere det som middleware, der skal kaldes hver gang du får adgang til et slutpunkt. Funktionen bliver som følger:
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']
});
}
};
- Modtagelse af req,res,næste som parameter. Da funktionen vil blive kaldt som middleware, skal du videregive de relevante parametre. req har adgang til anmodningsobjektet, hvorimod res har adgang til svarobjektet. næste bruges til at udføre den næste middleware på det specifikke slutpunkt
- Få adgang til miljøvariablerne forbrugernøgle, forbrugerhemmelighed og oauth_token_url
- Opret en buffer og indkod den derefter til en base64 streng
- Brug prøv, fang blok for at kommunikere med Daraja API. Hvis anmodningen lykkes, skal du indstille tokenet på anmodningsobjektet og derefter udføre den næste middleware. Ellers returner fejlen
Implementering af Lipa na M-Pesa online
Efter at have genereret et adgangstoken kan du nu implementere din kernefunktionalitet. Da Express.js er en serie af middleware-kald, vil du også implementere det som en middleware. Implementeringen skal være som følger:
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']
});
};
};
Implementeringen følger disse trin:
- Få adgang til tokenet, som vi gemte i anmodningsobjektet
- Tilføj bærer foran strengen for at oprette autorisationsstrengen
- Hent det aktuelle tidsstempel.
- Få Lipa na Mpesa URL'en, der er gemt som en miljøvariabel
- Få din virksomheds korte kode og adgangsnøgle. Fortsæt til din test legitimationsoplysninger. Kopier og indsæt derefter Lipa Na Mpesa Online Shortcode som forretningskortkoden til din .env fil og Lipa Na Mpesa online adgangsnøgle som adgangsnøgle
- Få adgangskoden, der er genereret fra en buffer, der består af forretningskortkode, adgangsnøgle og tidsstempel. Bufferen kodes derefter til en base64 streng
- Indstil transaktionstypen til CustomerPayBillOnline det er den eneste understøttede. Skift det ikke
- Indstil det beløb, der skal betales
- Indstil PartyA, som er telefonnummeret, der sender pengene. Telefonnummeret skal bruge 2547xxxxxxxxx format
- Indstil PartyB, som er forretningskortkoden
- Indstil telefonnummeret, der er telefonnummeret, der sender pengene. Brug formatet som forklaret i PartyA
- Indstil tilbagekalds-URL. Tilbagekalds-URL'en er det sted, hvor svaret vil blive behandlet. Du kan bruge ngrok
Sørg for, at din server kører med kommandoen:
npm run dev
Åbn derefter en anden fane og kør følgende kommando:
npm run ngrok
Dette vil videresende dig til et bestemt link som f.eks http://78066c1c2d6b.ngrok.io. Kopiér det link og indsæt callBackUrl-variablen. Bemærk, at linket er forskelligt, hver gang du stopper og starter serveren igen.
- Indstil kontoreferencen, som kan være en hvilken som helst streng, du angiver. Det refererer til, hvor pengene bliver betalt til
- Indstil transaktionsbeskrivelsen, som beskriver, hvad transaktionen er til
- Brug prøv, fang blokere, når du kommunikerer med Daraja API. Hvis processen er vellykket, returner meddelelsen fra API'en. Ellers returner fejlen fra API'en
Lipa na Mpesa online tilbagekald
Når du sender en anmodning, vil svaret fra API'en blive sendt via tilbagekaldet. Hvis du ønsker at opdatere nogle poster, kan du opdatere dem her baseret på svaret, der er sendt tilbage. Du implementerer et simpelt tilbagekald som metode i klassen.
lipaNaMpesaOnlineCallback(req,res){
//Get the transaction description
let message = req.body.Body.stkCallback['ResultDesc'];
return res.send({
success:true,
message
});
};
Få adgang til beskrivelsen af den gennemførte transaktion eller returner den sendte besked.
Tag væk
Hvis du vil skubbe din app i produktion, skal du ændre callback-URL'en til dit serverdomæne, når den hostes online. Når du har tilføjet legitimationsoplysninger til .env fil, skal du tilføje den til din .gitignore fil, så du ikke afslører dine legitimationsoplysninger, når du skubber dit projekt til GitHub.
