#
Le point de terminaison de vérification du solde permet à votre application de connaître en temps réel le nombre de crédits SMS restants sur votre compte.
- URL du point de terminaison :
https://api.fastermessage.com/v1/sms/balance - Méthode HTTP requise : Généralement GET (ou POST, selon les spécifications exactes non visibles, mais l’absence de paramètres de corps dans l’exemple suggère GET).
- Résultat : L’API retourne votre solde actuel. Le format est souvent JSON ou un simple texte/nombre, permettant un traitement facile par votre application.
Authentification #
Comme pour toutes les requêtes API (envoi de SMS, DLR, etc.), cette requête doit être authentifiée pour garantir que seul le titulaire du compte peut accéder aux informations de solde.
L’exemple de code utilise l’Authentification Basic :
- Encodage de
Mon_Username:Mon_Passworden Base64. - Transmission de cette clé dans le header
Authorization: Basic [Clé Base64].
PHP #
<?php
$url = 'https://api.fastermessage.com/v1/sms/balance;
$key = base64_encode("Mon_Username:Mon_Password");
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_RETURNTRANSFER,1);
curl_setopt($curl, CURLOPT_HTTPHEADER, array("Authorization: Basic ". $key));
$result = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
printf($result);
printf($status);
?>
Curl #
curl https://api.fastermessage.com/v1/sms/balance -X GET -H "Authorization: Basic Username_et_Paswword_encoder_en_base_64"
PYTHON #
import requests
url = 'https://api.fastermessage.com/v1/sms/balance'
headers = {'Authorization': 'Basic Username_et_Paswword_encoder_en_base_64'}
req = requests.get(url, data={}, headers=headers)
print(req.status_code)
print(req.headers)
print(req.text)
NODE JS #
const http = require('https');
const init = {
hostname: "https://api.fastermessage.com/v1/sms/balance",
path: "/",
method: "GET",
headers: {
"Authorization": "Basic Username_et_Paswword_encoder_en_base_64"
}
};
const request = http.request(init, (resp)=>{
let result = Buffer.alloc(0);
resp.on('data', function(chunk) {
result = Buffer.concat([result, chunk]);
});
resp.on('end', function() {
// result has response body buffer
console.log(result.toString());
});
});
request.end();
La réponse renvoyée par l’API est au format JSON comme suit :
{
"balance": 289009,
}
balance : c’est le solde disponible sur votre compte FASTERMESSAGE;