Guide de démarrage rapide
Ce guide vous prépare à utiliser l’API MeSomb. Vous apprendrez à démarrer avec un de nos clients API et à envoyer votre première requête. Vous trouverez également les ressources nécessaires pour tirer pleinement parti de notre API REST.
Avant d’envoyer des requêtes à l’API MeSomb, récupérez votre clé API dans votre tableau de bord, sous Compte » Développeur.
Choisissez votre client
Avant de faire votre première requête API, vous devez choisir le client API que vous utiliserez. En plus des bonnes vieilles requêtes HTTP cURL, Protocol propose des clients pour JavaScript, Python et PHP. Dans l’exemple suivant, vous pouvez voir comment installer chaque client.
<span><span style="color: var(--shiki-token-comment)"># Install the MeSomb JavaScript SDK</span></span> <span><span style="color: var(--shiki-color-text)">yarn add @hachther/mesomb</span></span> <span><span style="color: var(--shiki-token-comment)"># or</span></span> <span><span style="color: var(--shiki-color-text)">npm install @hachther/mesomb</span></span> <span></span>
Faire votre première requête API
Après avoir choisi votre client préféré, vous êtes prêt à effectuer votre premier appel à l’API MeSomb. Ci-dessous, vous pouvez voir comment effectuer une requête de collecte pour encaisser de l’argent pour un compte numérique.
POST
/api/v1.1/payment/collected<span><span style="color: var(--shiki-token-keyword)">import</span><span style="color: var(--shiki-color-text)"> {PaymentOperation</span><span style="color: var(--shiki-token-punctuation)">,</span><span style="color: var(--shiki-color-text)"> RandomGenerator} </span><span style="color: var(--shiki-token-keyword)">from</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'@hachther/mesomb'</span><span style="color: var(--shiki-color-text)">;</span></span> <span></span> <span><span style="color: var(--shiki-token-keyword)">const</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">applicationKey</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'<your application key>'</span></span> <span><span style="color: var(--shiki-token-keyword)">const</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">accessKey</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'<your access key>'</span></span> <span><span style="color: var(--shiki-token-keyword)">const</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">secretKey</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'<your secret key>'</span></span> <span><span style="color: var(--shiki-token-keyword)">const</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">client</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">new</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-function)">PaymentOperation</span><span style="color: var(--shiki-color-text)">(applicationKey</span><span style="color: var(--shiki-token-punctuation)">,</span><span style="color: var(--shiki-color-text)"> accessKey</span><span style="color: var(--shiki-token-punctuation)">,</span><span style="color: var(--shiki-color-text)"> secretKey);</span></span> <span></span> <span><span style="color: var(--shiki-token-keyword)">const</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">response</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">await</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">client</span><span style="color: var(--shiki-token-function)">.makeCollect</span><span style="color: var(--shiki-color-text)">({</span></span> <span><span style="color: var(--shiki-color-text)"> amount</span><span style="color: var(--shiki-token-keyword)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">100</span><span style="color: var(--shiki-token-punctuation)">,</span></span> <span><span style="color: var(--shiki-color-text)"> service</span><span style="color: var(--shiki-token-keyword)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'MTN'</span><span style="color: var(--shiki-token-punctuation)">,</span></span> <span><span style="color: var(--shiki-color-text)"> payer</span><span style="color: var(--shiki-token-keyword)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'677550203'</span><span style="color: var(--shiki-token-punctuation)">,</span></span> <span><span style="color: var(--shiki-color-text)"> nonce</span><span style="color: var(--shiki-token-keyword)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-constant)">RandomGenerator</span><span style="color: var(--shiki-token-function)">.nonce</span><span style="color: var(--shiki-color-text)">()</span><span style="color: var(--shiki-token-punctuation)">,</span></span> <span><span style="color: var(--shiki-color-text)"> trxID</span><span style="color: var(--shiki-token-keyword)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">'your_local_transaction_id'</span><span style="color: var(--shiki-token-punctuation)">,</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-comment)">// optional</span></span> <span><span style="color: var(--shiki-color-text)">});</span></span> <span></span> <span><span style="color: var(--shiki-token-constant)">response</span><span style="color: var(--shiki-color-text)">.success</span></span> <span><span style="color: var(--shiki-token-constant)">response</span><span style="color: var(--shiki-color-text)">.message</span></span> <span><span style="color: var(--shiki-token-constant)">response</span><span style="color: var(--shiki-color-text)">.status</span></span> <span><span style="color: var(--shiki-token-constant)">response</span><span style="color: var(--shiki-color-text)">.</span><span style="color: var(--shiki-token-constant)">transaction</span><span style="color: var(--shiki-color-text)">.pk</span></span> <span></span>
Quelle est la suite ?
Super, vous êtes maintenant configuré avec un client API et avez effectué votre première requête à l’API. Voici quelques liens qui pourraient vous être utiles alors que vous poursuivez votre exploration de l’API MeSomb :