Wykorzystanie API API

  • Używamy tokenów JWT do konfiguracji i administrowania kontem.
  • Używamy tokena API do uzyskania dostępu do rekordów, więc tylko token API zostanie przekazany do Twojego CRM.

Utwórz konto

  1. Użyj POST/auth/register, aby utworzyć konto
    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. Aktywuj swoje konto za pomocą e-maila, który powinieneś otrzymać

Wygeneruj swoje tokeny

  1. Uzyskaj token dostępu JWT z 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"}'
    });
    Odzew powinien być jak
    {"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}
    Przechowuj token w JWT_ACCESS_TOKEN
  2. Użyj tokena dostępu JWT POST/ovh/add, aby połączyć swoje konto 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"},
    });
    Odzew powinien być jak
    {"goto":"https://eu.api.ovh.com/auth/?credentialToken=abcdefgklmnop123456789"}
    REDIRECT_DONE https://rec.over.ovh/ovh/check/abcdeghijklmnopqrstuvwzy
  3. Możesz użyć tokena dostępu JWT POST/account/blocklist, aby ukryć niektóre rekordy i uniemożliwić dostęp do nich
    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"}'
    });
    Odzew powinien być jak
    ["0033123456789"]
  4. Użyj tokena dostępu JWT, aby utworzyć token API. Ten token będzie używany do uzyskiwania dostępu do Twoich danych 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}'
    });
    Odzew powinien być jak
    {"value":"1234567890abcdeghijklmnopqrstuvwzyZ","comment":"dev key","expireAt":"2021-06-29T21:46:32.006Z"}
    Teraz zachowaj token API do zmiennej o nazwie API_TOKEN

Wyszukaj swoje rekordy

Teraz możesz użyć tokena API, aby uzyskać dostęp do swoich rekordów GET/records

  • Odbierz wszystkie połączenia z lub na: +33112233 i +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"},
    });
  • Odbieraj wszystkie połączenia od lub do: +33112233 i +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"},
    });
  • Uzyskaj wszystkie połączenia dłuższe niż 10 minut
    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"},
    });
  • Uzyskaj wszystkie połączenia przychodzące dłuższe niż 10 minut
    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"},
    });