Introduction
Esta es la API pública para los servicios de Digevo AI. Tenemos bindings en Shell, Ruby, Python y JavaScript. Se pueden ver los ejemplos de código en el área oscura a la derecha, y se puede cambiar el lenguaje de programación de los ejemplos con las pestañas arriba a la derecha.
Autenticación
La autenticación de los servicios usa HTTP Basic Auth.
Solicitar a Digevo la creación de un user:password.
Hay que reemplazar el contenido del header
Authorizationpor la palabraBasicy el encoding en base64 de user:password para basic HTTP auth.A continuación un ejemplo de header de Authorization para
user:password
Basic ZGVtby11c2VyOnh4eHh4eHh4eHgtMTIzNDUteHh4eHh4eHh4eA==
Two-factor
Realizar llamado
require 'uri'
require 'net/http'
url = URI("http://supporting-services.services.smartia-ai.com/api/two-factor/dial")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request["Authorization"] = 'Basic dXNlcjpwYXNzd29yZA=='
request.body = "twoFactorKey=12345678&phonenumber=56911223344"
response = http.request(request)
puts response.read_body
import requests
url = "http://supporting-services.services.smartia-ai.com/api/two-factor/dial"
payload = "twoFactorKey=12345678&phonenumber=56911223344"
headers = {
'Content-Type': "application/x-www-form-urlencoded",
'Authorization': "Basic dXNlcjpwYXNzd29yZA=="
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
curl -X POST \
http://supporting-services.services.smartia-ai.com/api/two-factor/dial \
-H 'Authorization: Basic dXNlcjpwYXNzd29yZA=='
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'twoFactorKey=12345678&phonenumber=56911223344'
var request = require("request");
var options = { method: 'POST',
url: 'http://supporting-services.services.smartia-ai.com/api/two-factor/dial',
headers:
{ Authorization: 'Basic dXNlcjpwYXNzd29yZA==',
'Content-Type': 'application/x-www-form-urlencoded' },
form: { twoFactorKey: '12345678', phonenumber: '56911223344' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
El comando retorna
HTTP 200 OKen caso de que resulte.
El método gatilla un llamado al número especificado, para leerle un token. El token se separa automáticamente en grupos de 2 caracteres para que se lea más fácil.
HTTP Request
POST http://supporting-services.services.smartia-ai.com/api/two-factor/dial
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| phonenumber | (none) | Teléfono al cual hay que llamar de manera instantánea, con el prefijo internacional 56. |
| twoFactorKey | (none) | Clave para leérsela al usuario. |
Errors
Códigos de error de la API
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Request mal hecho. |
| 401 | Unauthorized -- Las credenciales de autenticación están malas. |
| 403 | Forbidden -- Funcionalidad no disponbile para el usuario indicado. |
| 429 | Too Many Requests -- Límite de uso de la API alcanzado, hay que esperar unos minutos. |
| 500 | Internal Server Error -- Problema interno en el server de Digevo. |
| 503 | Service Unavailable -- Server en mantención. |