שימוש ב- API

  • אנו משתמשים באסימונים של JWT כדי להגדיר ולנהל את החשבון.
  • אנו משתמשים באסימון API כדי לגשת לרשומות, כך שרק אסימון ה- API יינתן ל- CRM שלך.

צור חשבון

  1. השתמש ב- POST/auth/register כדי ליצור את חשבונך
    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. הפעל את חשבונך באמצעות הדואר האלקטרוני שהיית צריך לקבל

צור את האסימונים שלך

  1. קבל אסימון גישה JWT עם 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"}'
    });
    התגובה צריכה להיות כמו
    {"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}
    בואו לאחסן את האסימון ב- JWT_ACCESS_TOKEN
  2. השתמש באסימון ה- JWT שלך POST/ovh/add לקישור חשבון 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"},
    });
    התגובה צריכה להיות כמו
    {"goto":"https://eu.api.ovh.com/auth/?credentialToken=abcdefgklmnop123456789"}
    REDIRECT_DONE https://rec.over.ovh/ovh/check/abcdeghijklmnopqrstuvwzy
  3. אתה יכול להשתמש באסימון הגישה שלך ב- JWT POST/account/blocklist כדי להסתיר כמה רשומות ולמנוע גישה אליהם
    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"}'
    });
    התגובה צריכה להיות כמו
    ["0033123456789"]
  4. השתמש באסימון הגישה שלך ל- JWT כדי ליצור אסימון API. אסימון זה ישמש לגישה לרשומות שלך 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}'
    });
    התגובה צריכה להיות כמו
    {"value":"1234567890abcdeghijklmnopqrstuvwzyZ","comment":"dev key","expireAt":"2021-06-29T21:46:32.006Z"}
    כעת שמור על אסימון ה- API למשתנה בשם API_TOKEN

חפש את הרשומות שלך

כעת תוכל להשתמש באסימון ה- API כדי לגשת לרשומות שלך GET/records

  • קבל את כל השיחות מ- או אל: +33112233 ו- +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"},
    });
  • קבל את כל השיחות מ- +33112233 ו- +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"},
    });
  • קבל את כל השיחות יותר מ -10 דקות
    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"},
    });
  • קבל את כל השיחות הנמשכות יותר מ -10 דקות
    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"},
    });