Account

Serviços que permitem o acesso a informações da sua conta

Consulta de saldo

GET https://api-v3.smsfire.com.br/account/balance

Rate Limiter: Este serviço possui um limite global de 10 requisições por minuto a partir do mesmo IP.

Atenção: o saldo informado pode não estar atualizado em tempo real devido ao uso de cache.

Exemplos de requisição

const axios = require("axios").default;

const options = {
  method: 'GET',
  url: `https://api-v3.smsfire.com.br/account/balance`,
  headers: {Username: 'seu_usuario', Api_Token: 'seu_token'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

<?php

$endpoint = "https://api-v3.smsfire.com.br/account/balance";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Api_Token: seu_token",
        "Username: seu_usuario",
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

using System.Net.Http;
using Microsoft.AspNetCore.WebUtilities; // precisa do pacote Microsoft.AspNetCore.WebUtilities

var client = new HttpClient();

var endpoint = $"https://api-v3.smsfire.com.br/account/balance";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri(endpoint),
    Headers =
    {
        { "Api_Token", "seu_token" },
        { "Username", "seu_usuario" }
    }
};

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Response

O conjunto de dados retornados será em formato JSON com detalhes do envio ou possível falha da requisição

{
	"balance": 9.102,
	"limit": -10,
	"currency":"BRL"
}

Erros poderão ser facilmente filtrados a partir dos códigos HTTP retornados e adicionalmente detalhes do erro serão incluídos no JSON que seguirá o seguinte formato:

{
	"message": "Invalid Token or Username",
	"error": "Unauthorized",
	"statusCode": 400
}

AnteriorAutenticação PróximoSMS

Atualizado há 14 dias