token/{api

Genera un nuevo Token de autorización validando el código de renovación

URL del recurso

https://restapi.marketext.com/token/{api_id}

Autenticación

Nuestra API Rest utiliza un esquema de autenticación basado en esta especificación OAuth 2.

Authorization: Token

Todas las solicitudes de envío deberán incluir el encabezado Authorization con el siguiente formato:

Authorization: Token ASDFGHJKLZXCVBNMQWERTYUIOP1234567890==

Importante: Para refrescar el token, se debe incluir el encabezado de autenticación con el token expirado que se renovará.

Parámetros

Parámetro	Descripción	Requerido	Valor Predeterminado
user	ID del usuario al cual pertenece el Token	Obligatorio
grant_type	Su valor debe ser refresh_token	Obligatorio
refresh_token	Se debe especificar el código de renovación (refresh_token) que se recibió junto con el Token que se va a renovar	Obligatorio
token_lifetime	Define el tiempo de vida del Token generado (en segundos)	Opcional	86400
format	Solicita el formato de respuesta ya sea JSON/XML/CSV/URLencoded	Opcional

Ejemplo

POST	http://restapi.marketext.com/token/democompany

Solicitud

  
	$client = new RESTClient();
	$client->setUrl("http://restapi.marketext.com/token/democompany");
	$client->setMethod("GET");
	$client->execute();
	$response = $client->getLastResponse();
	$client->resetClient();

Formato Respuesta

Utilice el encabezado

para especificar el formato de salida deseado, si no es posible para usted definir el encabezado

, puede utilizar el parámetro

format

Tenga en cuenta que el parametro

format

tiene prioridad sobre el encabezado

Formatos disponibles:

Respuesta esperada	Parámetro a enviar
JSON	application/json
XML	application/xml
CSV	text/csv
Form URL Encoded	application/x-www-form-url-encoded

 JSON
  {
		access_token: "42bd834d6ab6d94a6ed8d9d909fc7df1ab81be0679f9baa5be9e483d0974f5",
		token_type: "Bearer",
		expires_in: 86400,
		refresh_token: "sQ5iX6K3q8MueEELAsWS2g2XeGKWqfAukuN7G9QpzZY=",
		scope: "send-sms"
  }

XML
  <?xml version="1.0"?>
		<respuesta>
			<access_token>42bd834d6ab6d94a6ed8d9d909fc7df1ab81be0679f9baa5be9e483d0974f5</access_token>
			<token_type>Bearer</token_type>
			<expires_in>86400</expires_in>
			<refresh_token>sQ5iX6K3q8MueEELAsWS2g2XeGKWqfAukuN7G9QpzZY=</refresh_token>
			<scope>send-sms</scope>
		</respuesta>

CSV
	42bd834d6ab6d94a6ed8d9d909fc7df1ab81be0679f9baa5be9e483d0974f5, Bearer, 86400,
	sQ5iX6K3q8MueEELAsWS2g2XeGKWqfAukuN7G9QpzZY=, send-sms

URLEncoded
	access_token=42bd834d6ab6d94a6ed8d9d909fc7df1ab81be0679f9baa5be9e483d0974f5&token_type=Bearer
	&expires_in=86400&refresh_token=sQ5iX6K3q8MueEELAsWS2g2XeGKWqfAukuN7G9QpzZY%3D&scope=send-sms

Códigos de error

La siguiente es una lista de códigos de respuesta del recurso y la frase estándar asociadas a ese código, más la explicación de los errores específicos que puedan generarse.

Las frases estándares están destinadas a dar una descripción intutiva del estatus, y la explicación específica permitirá encontrar el error más fácilmente.

El código de respuesta es enviado en el encabezado, y la explicación en el cuerpo de la respuesta.

Código	Descripción
400	Solicitud incorrecta. La solicitud contiene datos no válidos o faltantes
404	No encontrado. El URI no coincide con ninguno de los recursos disponibles, o, si solicita un recurso con un identificador, el recurso no existe
405	Método no permitido. El método de la petición HTTP que esta intentando utilizar no esta permitido. Verifique la documentación para ver los metodos permitidos

Formato Respuesta de Error

  
  JSON
    {
        "error": "No autorizado. Error de autenticaci\u00c3\u00b3n o no se proporcion\u00c3\u00b3 la informaci\u00c3\u00b3n de autenticaci\u00c3\u00b3n -> Error en solicitud, verifique los datos e int\u00c3\u00a9ntelo nuevamente "
    }

  XML
    <?xml version="1.0"?>
    <respuesta><error>No autorizado. Error de autenticación o no se proporcionó la información de autenticación -> Error en solicitud, verifique los datos e inténtelo nuevamente</error></respuesta>

  CSV
    No autorizado. Error de autenticación o no se proporcionó la información de autenticación -> Error en solicitud, verifique los datos e inténtelo nuevamente

  URLEncoded
    error=No autorizado. Error de autenticación o no se proporcionó la información de autenticación -> Error en solicitud, verifique los datos e inténtelo nuevamente

Información del recurso

Transferencia limitada	No
Formato de la respuesta	JSON/XML/CSV/URLencoded
Autenticación	Bearer Token Authentication Basada en esta especificación OAuth 2