Uso de API

  • Usamos tokens JWT para configurar y administrar la cuenta.
  • Usamos el token de API para acceder a los registros, por lo que solo se le entregará el token de API a su CRM.

Crea una cuenta

  1. Utilice POST/auth/register para crear su cuenta
    curl -H "Content-Type: application/json" --data-raw '{"user":"user@domain.com","password":"secretPassword"}' https://rec.over.ovh/auth/register | jq
    fetch("https://rec.over.ovh/auth/register", {
    method: "POST",
    headers: {"accept":"application/json"},
    body: '{"user":"user@domain.com","password":"secretPassword"}'
    });
  2. Active su cuenta con el correo electrónico que debería haber recibido

Genera tus tokens

  1. Obtenga un token de acceso JWT con POST/auth/login
    curl -H "Content-Type: application/json" --data-raw '{"user":"user@domain.com","password":"secretPassword"}' https://rec.over.ovh/auth/login | jq
    fetch("https://rec.over.ovh/auth/login", {
    method: "POST",
    headers: {"accept":"application/json"},
    body: '{"user":"user@domain.com","password":"secretPassword"}'
    });
    Resonse debería ser como
    {"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}
    Dejemos almacenar el token en JWT_ACCESS_TOKEN
  2. Utilice su token de acceso JWT POST/ovh/add para vincular su cuenta de OVH
    curl -X POST -H "Authorization: Bearer $JWT_ACCESS_TOKEN" https://rec.over.ovh/ovh/add | jq
    fetch("https://rec.over.ovh/ovh/add", {
    method: "POST",
    headers: {"accept":"application/json","Authorization":"Bearer JWT_ACCESS_TOKEN"},
    });
    Resonse debería ser como
    {"goto":"https://eu.api.ovh.com/auth/?credentialToken=abcdefgklmnop123456789"}
    REDIRECT_DONE https://rec.over.ovh/ovh/check/abcdeghijklmnopqrstuvwzy
  3. Puede utilizar su token de acceso JWT POST/account/blocklist para ocultar algunos registros y evitar el acceso a ellos.
    curl -H "Content-Type: application/json" --data-raw '{"number":"0033123456789"}' -H "Authorization: Bearer $JWT_ACCESS_TOKEN" https://rec.over.ovh/account/blocklist | jq
    fetch("https://rec.over.ovh/account/blocklist", {
    method: "POST",
    headers: {"accept":"application/json","Authorization":"Bearer JWT_ACCESS_TOKEN"},
    body: '{"number":"0033123456789"}'
    });
    Resonse debería ser como
    ["0033123456789"]
  4. Utilice su token de acceso JWT para crear un token de API. Este token se utilizará para acceder a sus registros POST/account/apitoken
    curl -H "Content-Type: application/json" --data-raw '{"comment":"dev key","ttl":36000}' -H "Authorization: Bearer $JWT_ACCESS_TOKEN" https://rec.over.ovh/account/apitoken | jq
    fetch("https://rec.over.ovh/account/apitoken", {
    method: "POST",
    headers: {"accept":"application/json","Authorization":"Bearer JWT_ACCESS_TOKEN"},
    body: '{"comment":"dev key","ttl":36000}'
    });
    Resonse debería ser como
    {"value":"1234567890abcdeghijklmnopqrstuvwzyZ","comment":"dev key","expireAt":"2021-06-29T21:46:32.006Z"}
    Ahora mantenga el token de API en una variable llamada API_TOKEN

Busque sus registros

Ahora puede usar el token de API para acceder a sus registros GET/records

  • Recibe todas las llamadas desde o hacia: +33112233 y +33112233
    curl -H "Authorization: Bearer $API_TOKEN" https://rec.over.ovh/records?number=0033112233&number=0033112233 | jq
    fetch("https://rec.over.ovh/records?number=0033112233&number=0033112233", {
    method: "GET",
    headers: {"accept":"application/json","Authorization":"Bearer API_TOKEN"},
    });
  • Recibe todas las llamadas de no desde o hacia: +33112233 y +33112233
    curl -H "Authorization: Bearer $API_TOKEN" https://rec.over.ovh/records?number=0033112233&number=0033112233&not=1 | jq
    fetch("https://rec.over.ovh/records?number=0033112233&number=0033112233&not=1", {
    method: "GET",
    headers: {"accept":"application/json","Authorization":"Bearer API_TOKEN"},
    });
  • Recibe todas las llamadas de más de 10 minutos
    curl -H "Authorization: Bearer $API_TOKEN" https://rec.over.ovh/records?durationmin=600 | jq
    fetch("https://rec.over.ovh/records?durationmin=600", {
    method: "GET",
    headers: {"accept":"application/json","Authorization":"Bearer API_TOKEN"},
    });
  • Recibe todas las llamadas entrantes de más de 10 minutos
    curl -H "Authorization: Bearer $API_TOKEN" https://rec.over.ovh/records?durationmin=600&direction=IN | jq
    fetch("https://rec.over.ovh/records?durationmin=600&direction=IN", {
    method: "GET",
    headers: {"accept":"application/json","Authorization":"Bearer API_TOKEN"},
    });