Manual Referencia API

API Key

Para hacer uso de la API deberá generar su API Key. Ingrese a su panel con usuario y contraseña (https://app.smsmasivos.com.mx) y generarla en la sección API de su panel de usuario (https://app.smsmasivos.com.mx/api)

API Key

La API Key es una clave única por cuenta, si necesitas cambiarla puedes volver a generar la API Key.

API Envío

Enviar mensaje por API Envío

Para enviar un SMS a través de API Envío, deberá realizar una petición a la siguiente dirección:

Parámetros a enviar

Parámetro	Descripción	Tipo de Dato
apikey	`Obligatorio` Clave generada en la sección API Key de este manual.	`Text`
mensaje	`Obligatorio` Mensaje que desea enviar, este no debe exceder caracteres permitidos 160 (SMS), la petición retornará el error correspondiente.	`Text`
numcelular	`Obligatorio` Número de celular del destinatario, formado por clave de ciudad y número, ejemplo: `5551234567`	`Text`
numregion	`Obligatorio` Clave de marcación del país, ejemplo: México `52`	`Number`
remitente	`Opcional` Agrega el nombre con hasta 11 caracteres alfanuméricos del remitente que contrataste. Si no lo tienes contratado, este parámetro se ignora. `Nota:` El remitente personalizado es un servicio que puedes contratar y que te permite enviar mensajes con el nombre de tu empresa en vez de un número, si te interesa información de su contratación, escríbenos en el chat.	`Text`
language	`Opcional` Idioma de la respuesta. Por defecto `es` . `es` Español. `en` Inglés.	`Text`
sandbox	`Opcional` Indica este parámetro sólo si requieres trabajar en un ambiente de pruebas. Esto con la finalidad de que tus mensajes no sean enviados ni descontados de tu crédito. El parámetro Sandbox debe tener el valor `1` . Tus envíos en modo Sandbox devolverán las mismas respuestas como si los enviaras sin esta forma y estarán disponibles para obtenerlos con API Reporte en modo Sandbox únicamente el mismo día del envío. `Nota:` Solo puedes realizar 1,000 envíos por día en modo Sandbox.	`Number`

Respuestas API Envío

{"Estatus":"ok", "mensaje":"Mensaje enviado", "referencia":"<referencia>"}

{"Estatus":"error", "mensaje":"APIKey no definido","Código":"01"}

{"Estatus":"error", "mensaje":"Mensaje no definido", "Código":"02"}

{"Estatus":"error", "mensaje":"Mensaje supera 160 caracteres", "Código":"03"}

{"Estatus":"error", "mensaje":"Número de celular no definido", "Código":"04"}

{"Estatus":"error", "mensaje":"El número de celular debe ser números", "Código":"05"}

{"Estatus":"error", "mensaje":"Número de región no definido", "Código":"06"}

{"Estatus":"error", "mensaje":"Número de celular debe contener 10 dígitos", "Código":"07"}

{"Estatus":"error", "mensaje":"Número de celular contiene menos de 6 dígitos", "Código":"08"}

{"Estatus":"error", "mensaje":"APIKey incorrecta", "Código":"10"}

{"Estatus":"error", "mensaje":"Crédito insuficiente. Crédito actual: <credito>", "Código":"13"}

{"Estatus":"error", "mensaje":"Solo puedes realizar hasta 1,000 envíos por día en modo sandbox.", "Código":"22"}

{"Estatus":"error", "mensaje":"Usuario no autorizado", "Código":"23"}

              
curl -X GET /v1/sms/send --data 'apikey=TU APIKEY AQUI&mensaje=Mensaje de prueba&numcelular=5551234567&numregion=52'

                
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "/v1/sms/send",
  CURLOPT_GET => TRUE,
  CURLOPT_RETURNTRANSFER => TRUE,
  CURLOPT_GETFIELDS => array(
      "apikey" => "TU APIKEY AQUI",
      "mensaje" => "Mensaje de prueba",
      "numcelular" => "5551234567",
      "numregion" => "52"
  )
));

$respuesta = curl_exec($ch);
curl_close($ch);
$respuesta = json_decode($respuesta);
echo $respuesta->mensaje;

                
require 'net/https'

uri = URI.parse("/v1/sms/send")

https = Net::HTTP.new(uri.host,uri.port)

request = Net::HTTP::GET.new(uri.request_uri)
request.set_form_data({"data[apikey]" => "TU APIKEY AQUI", "data[mensaje]" => "Mensaje de prueba", "data[numcelular]" => "5551234567", "data[numregion]" => "52" })

response = https.request(request)
render :json => response.body

                
String mensaje = "Mensaje de prueba";
String numero = "5551234567";
String api = "TU APIKEY AQUI";
String urlRequest="/v1/sms/send";
String urlParametros = "apikey=" + URLEncoder.encode(api, "UTF-8") +
"&mensaje=" + URLEncoder.encode(mensaje, "UTF-8") +
"&numcelular=" + URLEncoder.encode(numero, "UTF-8") +
"&numregion=" + URLEncoder.encode("52", "UTF-8");

URL url;
HttpsURLConnection conexion = null;

try {
    //-----------------------CREAR CONEXION----------------------------
    url = new URL(urlRequest);
    conexion = (HttpsURLConnection)url.openConnection();
    conexion.addRequestProperty("User-Agent", ""); 
    conexion.setRequestMethod("GET");
    conexion.setRequestProperty("Content-Type","application/x-www-form-urlencoded");
    conexion.setRequestProperty("Content-Length", ", " + Integer.toString(urlParametros.getBytes().length));
    conexion.setRequestProperty("Content-Language", "en-US");
    conexion.setUseCaches (false);
    conexion.setDoInput(true);
    conexion.setDoOutput(true);
    //-----------------------------------------------------------------

    //--------------------ENVIAR PETICION------------------------------
    DataOutputStream wr = new DataOutputStream ( conexion.getOutputStream() );
    wr.writeBytes(urlParametros);
    wr.flush();
    wr.close();
    //-----------------------------------------------------------------

    //-----------------------OBTENER RESPUESTA-------------------------
    InputStream is = conexion.getInputStream();
    BufferedReader rd = new BufferedReader(new InputStreamReader(is,"UTF-8"));
    String line;
    StringBuffer responsee = new StringBuffer();
    while((line = rd.readLine()) != null) {
      responsee.append(line);
      responsee.append('\r');
    }
    rd.close();
    String respuesta = responsee.toString();
    //-----------------------------------------------------------------

    //-------------Decodificar JSON con libreria org.json--------------
    JSONObject jsonObject = new JSONObject(respuesta);

    if(jsonObject.getString("estatus").equals("ok")){
        out.print(jsonObject.getString("mensaje")+"
");
        out.print("Referencia: "+jsonObject.getString("referencia")+"
");
    }else{
        out.print(jsonObject.getString("mensaje")+"
");
        out.print("Codigo error: "+jsonObject.getString("Código")+"
");
    }
    //-----------------------------------------------------------------

}catch (Exception e) {
  out.print(e);
}finally {
  if(conexion != null) conexion.disconnect();
}

                
var request = require('request'); //Se necesita instalar 'npm request' previamente en

var targetURL = '/v1/sms/send'
var response = request.GET(
	{ url: targetURL,
        form: {
            "apikey": "TU APIKEY AQUI",
            "mensaje": "Mensaje de prueba",
            "numcelular": "5551234567",
            "numregion": "52"
        }
    }, function(err, res, body) {
        if(err == null){
            console.log(body)
        } else{
            console.log(err);
        }
    }
);

                
# -*- coding: utf-8 -*-
import urllib, urllib2, json, cgi, webapp2

class enviarMensaje (webapp2.RequestHandler):
    def GET(self):
      numero = cgi.escape("5551234567")
      mensaje = cgi.escape("Mensaje de prueba")
      parametros = urllib.urlencode({'apikey':'TU APIKEY AQUI','mensaje': mensaje,'numcelular': numero,'numregion':'52'})
      headers = {"Content-type": "application/x-www-form-urlencoded", "Accept":"text/plain"}
      request = urllib2.Request('/v1/sms/send', parametros, headers)
      opener = urllib2.build_opener()
      respuesta = opener.open(request).read()
      j=json.loads(respuesta)
      self.response.write( j['mensaje'] )

appWeb = webapp2.WSGIApplication([
    ('/enviarMensaje',enviarMensaje),
    ],debug=True)

                
No available

                
No available

                
using System;

public string urlenviomensaje = "/v1/sms/send";

string mensaje = "Mensaje de prueba";
mensaje = mensaje.Replace(" ", "%20");
string numecelular = "5551234567";
string apikey = "TU APIKEY AQUI";
string codigotupais = "52";
string GETString = "apikey=" + apikey + "&mensaje=" + mensaje + "&numcelular=" + numecelular + "&numregion=" + codigotupais + ", ";

byte[] byteArray = Encoding.UTF8.GetBytes(GETString);
const string contentType = "application/x-www-form-urlencoded";
System.Net.ServicePointManager.Expect100Continue = false;

CookieContainer cookies = new CookieContainer();
HttpWebRequest webRequest = WebRequest.Create(urlenviomensaje) as HttpWebRequest;
webRequest.Method = "GET";
webRequest.ContentType = contentType;
webRequest.CookieContainer = cookies;
webRequest.ContentLength = byteArray.Length;

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(GETString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();
textboxError.Text = responseData;
responseReader.Close();
webRequest.GetResponse().Close();

API Envío por lotes

Enviar mensaje por API envío por lote

Para enviar un mensaje a través de API Envío por lote, deberá realizar una petición a la siguiente dirección:

Parámetros a enviar

Parámetro	Descripción	Tipo de Dato
apikey	`Obligatorio` Clave generada en la sección API Key de este manual.	`Text`
mensaje	`Obligatorio` Mensaje que desea enviar, este no debe exceder caracteres permitidos 160 (SMS), la petición retornará el error correspondiente.	`Text`
numcelular	`Obligatorio` Número de celular del destinatario, formado por clave de ciudad y número, ejemplo: `5551234567,4770123456,4421234567`	`Text`
numregion	`Obligatorio` Clave de marcación del país, ejemplo: México `52`	`Number`
remitente	`Opcional` Agrega el nombre con hasta 11 caracteres alfanuméricos del remitente que contrataste. Si no lo tienes contratado, este parámetro se ignora. `Nota:` El remitente personalizado es un servicio que puedes contratar y que te permite enviar mensajes con el nombre de tu empresa en vez de un número, si te interesa información de su contratación, escríbenos en el chat.	`Text`
language	`Opcional` Idioma de la respuesta. Por defecto `es` . `es` Español. `en` Inglés.	`Text`
sandbox	`Opcional` Indica este parámetro sólo si requieres trabajar en un ambiente de pruebas. Esto con la finalidad de que tus mensajes no sean enviados ni descontados de tu crédito. El parámetro Sandbox debe tener el valor `1` . Tus envíos en modo Sandbox devolverán las mismas respuestas como si los enviaras sin esta forma y estarán disponibles para obtenerlos con API Reporte en modo Sandbox únicamente el mismo día del envío. `Nota:` Solo puedes realizar 1,000 envíos por día en modo Sandbox.	`Number`

Respuestas API envío por lote

{"respuestas": [
{ "Estatus":"ok", "mensaje":"Mensaje enviado", "referencia":"<referencia>", "numcelular":"<numero>" }
]}

{"respuestas": [{"Estatus":"error", "mensaje":"APIKey no definido","Código":"01"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Mensaje no definido", "Código":"02"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Mensaje supera 160 caracteres", "Código":"03"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Número de celular no definido", "Código":"04"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"El número de celular debe ser números", "Código":"05", "numcelular": "<numero>"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Número de región no definido", "Código":"06"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Número de celular debe contener 10 dígitos", "Código":"07", "numcelular": "<numero>"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Número de celular contiene menos de 6 dígitos", "Código":"08", "numcelular": "<numero>"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"APIKey incorrecta", "Código":"10"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Crédito insuficiente. Crédito actual: <credito>", "Código":"13"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"No puedes enviar más de 500 mensajes a la vez", "Código":"14"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Número de celular repetido", "Código":"15", "numcelular": "<numero>"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Se encontraron dos comas seguidas(,,) en el campo numcelular", "Código":"21"}] }

{"respuestas": [{"Estatus":"error", "mensaje":"Solo puedes realizar hasta 1,000 envíos por día en modo sandbox.", "Código":"22"}] }

Ejemplo respuesta:
{"respuestas": [
{"Estatus":"error", "mensaje":"Número de celular debe contener 10 dígitos", "Código":"07", "numcelular": "47739981888181"},
{"Estatus":"error", "mensaje":"El número de celular debe ser números", "Código":"05", "numcelular": "47739YKX18"},
{"Estatus":"error", "mensaje":"Número de celular repetido", "Código":"15", "numcelular": "4771234567"},
{"Estatus":"ok", "mensaje":"Mensaje enviado", "referencia":"20140305020339582444", "numcelular":"4771234567"}
]}

              
curl -X GET /v1/sms/send/multi --data 'apikey=TU APIKEY AQUI&mensaje=Mensaje de prueba&numcelular=4771234567,5551234567,4777654321&numregion=52'

                
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "/v1/sms/send/multi",
  CURLOPT_GET => TRUE,
  CURLOPT_RETURNTRANSFER => TRUE,
  CURLOPT_GETFIELDS => array(
    "apikey" => "TU APIKEY AQUI",
    "mensaje" => "Mensaje de prueba",
    "numcelular" => "4771234567,5551234567,4777654321",
    "numregion" => "52"
  )
));

$respuesta = curl_exec($ch);
curl_close($ch);
$respuesta = json_decode($respuesta);
echo $respuesta->mensaje;

                
require 'net/https'

uri = URI.parse("/v1/sms/send/multi")

https = Net::HTTP.new(uri.host,uri.port)

request = Net::HTTP::GET.new(uri.request_uri)
request.set_form_data({"data[apikey]" => "TU APIKEY AQUI", "data[mensaje]" => "Mensaje de prueba", "data[numcelular]" => "4771234567,5551234567,4777654321", "data[numregion]" => "52" })

response = https.request(request)
render :json => response.body

                
String mensaje = "Mensaje de prueba";
String numero = "4771234567,5551234567,4777654321";
String api = "TU APIKEY AQUI";
String urlRequest="/v1/sms/send/multi";
String urlParametros = "apikey=" + URLEncoder.encode(api, "UTF-8") +
"&mensaje=" + URLEncoder.encode(mensaje, "UTF-8") +
"&numcelular=" + URLEncoder.encode(numero, "UTF-8") +
"&numregion=" + URLEncoder.encode("52", "UTF-8");

URL url;
HttpsURLConnection conexion = null;

try {
  //-----------------------CREAR CONEXION----------------------------
  url = new URL(urlRequest);
  conexion = (HttpsURLConnection)url.openConnection();
  conexion.addRequestProperty("User-Agent", ""); 
  conexion.setRequestMethod("GET");
  conexion.setRequestProperty("Content-Type","application/x-www-form-urlencoded");
  conexion.setRequestProperty("Content-Length", ", " + Integer.toString(urlParametros.getBytes().length));
  conexion.setRequestProperty("Content-Language", "en-US");
  conexion.setUseCaches (false);
  conexion.setDoInput(true);
  conexion.setDoOutput(true);
  //-----------------------------------------------------------------

  //--------------------ENVIAR PETICION------------------------------
  DataOutputStream wr = new DataOutputStream ( conexion.getOutputStream() );
  wr.writeBytes(urlParametros);
  wr.flush();
  wr.close();
  //-----------------------------------------------------------------

  //-----------------------OBTENER RESPUESTA-------------------------
  InputStream is = conexion.getInputStream();
  BufferedReader rd = new BufferedReader(new InputStreamReader(is,"UTF-8"));
  String line;
  StringBuffer responsee = new StringBuffer();
  while((line = rd.readLine()) != null) {
    responsee.append(line);
    responsee.append('\r');
  }
  rd.close();
  String respuesta = responsee.toString();
  //-----------------------------------------------------------------

  //-------------Decodificar JSON con libreria org.json--------------
  JSONObject jsonObject = new JSONObject(respuesta);

  if(jsonObject.getString("estatus").equals("ok")){
    out.print(jsonObject.getString("mensaje")+"
");
    out.print("Referencia: "+jsonObject.getString("referencia")+"
");
  }else{
    out.print(jsonObject.getString("mensaje")+"
");
    out.print("Codigo error: "+jsonObject.getString("estatus")+"
");
  }
  //-----------------------------------------------------------------

}catch (Exception e) {
  out.print(e);
}finally {
  if(conexion != null) conexion.disconnect();
}

                
var request = require('request'); //Se necesita instalar 'npm request' previamente en

var targetURL = '/v1/sms/send/multi'
var response = request.GET(
	{ url: targetURL,
    form: {
      "apikey": "TU APIKEY AQUI",
      "mensaje": "Mensaje de prueba",
      "numcelular": 4771234567,5551234567,4777654321,
      "numregion": "52"
    }
  }, function(err, res, body) {
    if(err == null){
      console.log(body)
    } else{
      console.log(err);
    }
  }
);

                
# -*- coding: utf-8 -*-
import urllib, urllib2, json, cgi, webapp2

class enviarMensaje (webapp2.RequestHandler):
  def GET(self):
    numero = cgi.escape("4771234567,5551234567,4777654321")
    mensaje = cgi.escape("Mensaje de prueba")
    parametros = urllib.urlencode({'apikey':'TU APIKEY AQUI','mensaje': mensaje,'numcelular': numero,'numregion':'52'})
    headers = {"Content-type": "application/x-www-form-urlencoded", "Accept":"text/plain"}
    request = urllib2.Request('/v1/sms/send/multi', parametros, headers)
    opener = urllib2.build_opener()
    respuesta = opener.open(request).read()
    j=json.loads(respuesta)
    self.response.write( j['mensaje'] )

appWeb = webapp2.WSGIApplication([
  ('/enviarMensaje',enviarMensaje),
  ],debug=True)

                
No available

                
No available

                
using System;

public string urlenviomensaje = "/api/api.multienvio.sms.php";

string mensaje = "Mensaje de prueba";
mensaje = mensaje.Replace(" ", "%20");
string numecelular = "4771234567,5551234567,4777654321";
string apikey = "TU APIKEY AQUI";
string codigotupais = "52";
string GETString = "apikey=" + apikey + "&mensaje=" + mensaje + "&numcelular=" + numecelular + "&numregion=" + codigotupais + ", ";

byte[] byteArray = Encoding.UTF8.GetBytes(GETString);
const string contentType = "application/x-www-form-urlencoded";
System.Net.ServicePointManager.Expect100Continue = false;

CookieContainer cookies = new CookieContainer();
HttpWebRequest webRequest = WebRequest.Create(urlenviomensaje) as HttpWebRequest;
webRequest.Method = "GET";
webRequest.ContentType = contentType;
webRequest.CookieContainer = cookies;
webRequest.ContentLength = byteArray.Length;

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(GETString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();
textboxError.Text = responseData;
responseReader.Close();
webRequest.GetResponse().Close();

API Reporte

Use API Reporte para ver el status de sus mensajes enviados en un rango de fechas

Para ver su reporte a través de API Reporte, deberá realizar una petición a la siguiente dirección:

Usted podrá realizar hasta 10 peticiones por día a API Reporte.

Parámetros a enviar

Parámetro	Descripción	Tipo de Dato
apikey	`Obligatorio` Clave generada en la sección API Key de este manual.	`Text`
fechainicio	`Obligatorio` Fecha de inicio de su reporte. Ejemplo: `2014-03-21 00:00:00`	`Text`
fechafin	`Obligatorio` Fecha de fin de su reporte. Ejemplo: `2014-03-21 23:59:59`	`Text`
sandbox	`Opcional` Indica este parámetro solo si requieres trabajar en un ambiente de pruebas y obtener los mensajes enviados por API Envío y multienvío en modo Sandbox el mismo día de tu petición a API Reporte. El parámetro Sandbox debe tener el valor `1` .	`Text`

Respuestas API Reporte

{"respuestas": [{ "referencia":"<Referencia>","destino":"<Número>","mensaje":"<Mensaje:>","fecha":"<Fecha>","Estatus":"<Estatus>","operador":"<Operador>","forma":"<Tipo envío>"}] }

{"Estatus":"error", "mensaje":"APIKey no definido","Código":"01"}

{"Estatus":"error", "mensaje":"APIKey incorrecta", "Código":"10"}

{"Estatus":"error", "mensaje":"Fecha inicio no definida", "Código":"16"}

{"Estatus":"error", "mensaje":"Fecha fin no definida", "Código":"17"}

{"Estatus":"error", "mensaje":"Fecha inicio es mayor a fecha fiN", "Código":"19"}

{"Estatus":"error", "mensaje":"Solo puedes realizar 10 peticiones a la API por día", "Código":"20"}

Ejemplo respuesta:
{ "respuestas": [
{"referencia":"20140321090355579615", "destino":"524771234567", "mensaje":"Mensaje: 1", "fecha":"2014-03-21 09:42:55", "Estatus":"0", "operador":"Telcel", "forma":"sms"},
{"referencia":"10222124170aEBDwGBeCs", "destino":"524771234567", "mensaje":"Mensaje: 2", "fecha":"2014-03-14 18:29:55", "Estatus":"0", "operador":"Telcel", "forma":"sms"},
{"referencia":"12212510280lEcfrkFziw", "destino":"524771234567", "mensaje":"Mensaje: 3", "fecha":"2014-03-14 18:29:55", "Estatus":"0", "operador":"Telcel", "forma":"sms"}
] }

estatus	Consiste en un número que corresponde al estatus que fue devuelto por el envío de tu mensaje. Los estatus pueden ser: `0` Entregado `1` No entregado `2` Error `3` Expirado `4` Rechazado `5` Desconocido `6` No existe `7` Formato incorrecto `8` Pendiente

              
curl -X GET /v1/reports/generate --data 'apikey=TU API KEY AQUI&fechainicio=2000-01-01 00:00:00&fechafin=2000-12-31 00:00:00'

                
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "/v1/reports/generate",
  CURLOPT_GET => TRUE,
  CURLOPT_RETURNTRANSFER => TRUE,
  CURLOPT_GETFIELDS => array(
    "apikey" => "TU APIKEY AQUI",
    "fechainicio" => "2000-01-01 00:00:00",
    "fechafin" => "2000-12-31 00:00:00"
  )
));

$respuesta = curl_exec($ch);
curl_close($ch);
$respuesta = json_decode($respuesta);
echo $respuesta->mensaje;

                
require 'net/https'

uri = URI.parse("/v1/reports/generate")

https = Net::HTTP.new(uri.host,uri.port)

request = Net::HTTP::GET.new(uri.request_uri)
request.set_form_data({"data[apikey]" => "TU APIKEY AQUI", "data[fechainicio]" => "2000-01-01 00:00:00", "data[fechafin]" => "2000-12-31 00:00:00" })

response = https.request(request)
render :json => response.body

                
String finicio = "2000-01-01 00:00:00";
String ffin = "2000-12-31 00:00:00";
String api = "TU APIKEY AQUI";
String urlRequest="/v1/reports/generate";
String urlParametros = "apikey=" + URLEncoder.encode(api, "UTF-8") +
"&fechainicio=" + URLEncoder.encode(finicio, "UTF-8") +
"&fechafin=" + URLEncoder.encode(ffin, "UTF-8");

URL url;
HttpsURLConnection conexion = null;

try {
  //-----------------------CREAR CONEXION----------------------------
  url = new URL(urlRequest);
  conexion = (HttpsURLConnection)url.openConnection();
  conexion.addRequestProperty("User-Agent", ""); 
  conexion.setRequestMethod("GET");
  conexion.setRequestProperty("Content-Type","application/x-www-form-urlencoded");
  conexion.setRequestProperty("Content-Length", ", " + Integer.toString(urlParametros.getBytes().length));
  conexion.setRequestProperty("Content-Language", "en-US");
  conexion.setUseCaches (false);
  conexion.setDoInput(true);
  conexion.setDoOutput(true);
  //-----------------------------------------------------------------

  //--------------------ENVIAR PETICION------------------------------
  DataOutputStream wr = new DataOutputStream ( conexion.getOutputStream() );
  wr.writeBytes(urlParametros);
  wr.flush();
  wr.close();
  //-----------------------------------------------------------------

  //-----------------------OBTENER RESPUESTA-------------------------
  InputStream is = conexion.getInputStream();
  BufferedReader rd = new BufferedReader(new InputStreamReader(is,"UTF-8"));
  String line;
  StringBuffer responsee = new StringBuffer();
  while((line = rd.readLine()) != null) {
    responsee.append(line);
    responsee.append('\r');
  }
  rd.close();
  String respuesta = responsee.toString();
  //-----------------------------------------------------------------

  //-------------Decodificar JSON con libreria org.json--------------
  JSONObject jsonObject = new JSONObject(respuesta);

  if(jsonObject.getString("estatus").equals("ok")){
    out.print(jsonObject.getString("mensaje")+"
");
    out.print("Referencia: "+jsonObject.getString("referencia")+"
");
  }else{
    out.print(jsonObject.getString("mensaje")+"
");
    out.print("Codigo error: "+jsonObject.getString("estatus")+"
");
  }
  //-----------------------------------------------------------------

}catch (Exception e) {
  out.print(e);
}finally {
  if(conexion != null) conexion.disconnect();
}

                
var request = require('request'); //Se necesita instalar 'npm request' previamente en

var targetURL = '/v1/reports/generate'
var response = request.GET(
	{ url: targetURL,
    form: {
      "apikey": "TU APIKEY AQUI",
      "fechainicio": "2000-01-01 00:00:00",
      "fechafin": "2000-12-31 00:00:00"
    }
  }, function(err, res, body) {
    if(err == null){
      console.log(body)
    } else{
      console.log(err);
    }
  }
);

                
# -*- coding: utf-8 -*-
import urllib, urllib2, json, cgi, webapp2

class enviarMensaje (webapp2.RequestHandler):
  def GET(self):
    fechafin = cgi.escape("2000-12-31 00:00:00")
    fechainicio = cgi.escape("2000-01-01 00:00:00")
    parametros = urllib.urlencode({'apikey':'TU APIKEY AQUI','fechainicio': fechainicio,'fechafin': fechafin})
    headers = {"Content-type": "application/x-www-form-urlencoded", "Accept":"text/plain"}
    request = urllib2.Request('/v1/reports/generate', parametros, headers)
    opener = urllib2.build_opener()
    respuesta = opener.open(request).read()
    j=json.loads(respuesta)
    self.response.write( j['mensaje'] )

appWeb = webapp2.WSGIApplication([
  ('/enviarMensaje',enviarMensaje),
  ],debug=True)

                
No available

                
No available

                
using System;

public string urlenviomensaje = "/v1/reports/generate";

string fechainicio = "2000-12-31 00:00:00";
string fechafin = "2000-01-01 00:00:00";
string apikey = "TU APIKEY AQUI";
string GETString = "apikey=" + apikey + "&fechainicio=" + fechainicio + "&fechafin=" + fechafin + ", ";

byte[] byteArray = Encoding.UTF8.GetBytes(GETString);
const string contentType = "application/x-www-form-urlencoded";
System.Net.ServicePointManager.Expect100Continue = false;

CookieContainer cookies = new CookieContainer();
HttpWebRequest webRequest = WebRequest.Create(urlenviomensaje) as HttpWebRequest;
webRequest.Method = "GET";
webRequest.ContentType = contentType;
webRequest.CookieContainer = cookies;
webRequest.ContentLength = byteArray.Length;

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(GETString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();
textboxError.Text = responseData;
responseReader.Close();
webRequest.GetResponse().Close();

API Crédito

Usa API crédito para obtener tu crédito actual.

Realiza tu petición a la siguiente dirección:

Parámetros a enviar

Parámetro	Descripción	Tipo de Dato
apikey	`Obligatorio` Clave generada en la sección API Key de este manual.	`Text`
lenguaje	`Opcional` Language	`Text`

Respuestas API Crédito

{"Estatus":"ok", "credito": ""}

{"Estatus":"error", "mensaje":"APIKey no definido", "Código":"01"}

{"Estatus":"error", "mensaje":"APIKey incorrecta", "Código":"10"}

              
curl -X GET /v1/credits/consult --data 'apikey=TU APIKEY AQUI'

                
curl_setopt_array($ch = curl_init(), array(
  CURLOPT_URL => "/v1/credits/consult",
  CURLOPT_GET => TRUE,
  CURLOPT_RETURNTRANSFER => TRUE,
  CURLOPT_GETFIELDS => array(
    "apikey" => "TU API KEY AQUI"
  )
));

$respuesta=curl_exec($ch);
curl_close($ch);
$respuesta=json_decode($respuesta);
if ($respuesta->estatus=="ok"){
  echo $respuesta->credito;
} else {
  echo $respuesta->mensaje;
}

                
No available

                
String urlRequest="/v1/credits/consult";
String urlParametros = "apikey=" + URLEncoder.encode("TU API KEY AQUI", "UTF-8");

URL url;
HttpsURLConnection conexion = null;
try {
  //-----------------------crear conexion----------------------------
  url = new URL(urlRequest);
  conexion = (HttpsURLConnection)url.openConnection();
  conexion.addRequestProperty("User-Agent", ""); 
  conexion.setRequestMethod("GET");
  conexion.setRequestProperty("Content-Type","application/x-www-form-urlencoded");
  conexion.setRequestProperty("Content-Length", "" + Integer.toString(urlParametros.getBytes().length));
  conexion.setRequestProperty("Content-Language", "en-US");
  conexion.setUseCaches (false);
  conexion.setDoInput(true);
  conexion.setDoOutput(true);
  //-----------------------------------------------------------------


  //--------------------Enviar Peticion------------------------------
  DataOutputStream wr = new DataOutputStream ( conexion.getOutputStream() );
  wr.writeBytes(urlParametros);
  wr.flush();
  wr.close();
  //-----------------------------------------------------------------


  //-----------------------Obtener Respuesta-------------------------
  InputStream is = conexion.getInputStream();
  BufferedReader rd = new BufferedReader(new InputStreamReader(is,"UTF-8"));
  String line;
  StringBuffer responsee = new StringBuffer();
  while((line = rd.readLine()) != null) {
    responsee.append(line);
    responsee.append('\r');
  }
  rd.close();
  String respuesta = responsee.toString();
  //-----------------------------------------------------------------

  //-------------Decodificar JSON con libreria org.json--------------
  JSONObject jsonObject = new JSONObject(respuesta);

  if(jsonObject.getString("estatus").equals("ok")){
    out.print("Crédito: "+jsonObject.getString("credito"));
  }else{
    out.print(jsonObject.getString("mensaje")+"
");
    out.print("Codigo error: "+jsonObject.getString("codigo"));
  }
  //-----------------------------------------------------------------

}catch (Exception e) {
  out.print(e);
}finally {
  if(conexion != null) conexion.disconnect();
}

                
No available

                
# -*- coding: utf-8 -*-
import urllib, urllib2, json, cgi, webapp2

class consultarCreditos (webapp2.RequestHandler):
  def GET(self):
    parametros = urllib.urlencode({'apikey':'TU APIKEY AQUI'})
    headers = {"Content-type": "application/x-www-form-urlencoded", "Accept":"text/plain"}
    request = urllib2.Request('/v1/credits/consult', parametros, headers)
    opener = urllib2.build_opener()
    respuesta = opener.open(request).read()
    j=json.loads(respuesta)
    self.response.write( j['mensaje'] )

appWeb = webapp2.WSGIApplication([
  ('/consultarCreditos',consultarCreditos),
  ],debug=True)

                
No available

                
No available

                
using System;

public string urlcredito = "/v1/credits/consult";

string apikey = "TU APIKEY AQUI";
string GETString = "apikey=" + apikey;

const string contentType = "application/x-www-form-urlencoded";
System.Net.ServicePointManager.Expect100Continue = false;

CookieContainer cookies = new CookieContainer();
HttpWebRequest webRequest = WebRequest.Create(urlcredito) as HttpWebRequest;
webRequest.Method = "GET";
webRequest.ContentType = contentType;
webRequest.CookieContainer = cookies;
webRequest.ContentLength = GETString.Length;

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(GETString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();
textboxError.Text = responseData;
responseReader.Close();
webRequest.GetResponse().Close();

Librerías de ejemplo API V1

Lista de lenguajes disponibles

Lenguaje	Recursos
PHP	Link del ejemplo: `Ejemplo librería PHP`
C#	Link del ejemplo: `Ejemplo librería C#`
Python	Link del ejemplo: `Ejemplo librería Python`
JAVA	Link del ejemplo: `Ejemplo librería JAVA`