Hitelesítés

A SURVIOT API-hoz való hozzáféréshez hitelesítés szükséges.

A hitelesítést a SURVIOT az ügyfelek számára az OAuth 2.0 Client Credentials eljáráson keresztül teszi lehetővé.

OAuth 2-alkalmazás regisztrációja

A SURVIOT jelenleg nem támogatja OAuth 2-alkalmazások önálló regisztrációját. A regisztrációhoz keresse fel a rendszergazdáját, vagy írjon az [email protected] e-mail címre.

Az alkalmazásregisztráció eredményeképp egy ügyfélazonosítóból (client id) és ügyfélkódból (client secret) álló hitelesítőadat-pár áll elő. A továbbiakban ezeket használhatja személyazonossága igazolásához.

Ügyfélazonosítója és ügyfélkódja érzékeny adat, melynek birtokában bárki hozzáférhet SURVIOT-projektjéhez. Hitelesítőadat-párját kezelje titkosan, és ne adja át harmadik félnek.

Hozzáférési token beszerzése

Az API használatához hozzáférési tokenre (access tokenre) van szüksége, amely a hitelesítési folyamat eredményeképp áll elő.

A hitelesítés megkezdéséhez küldjön kérést a https://surviot.auth.eu-central-1.amazoncognito.com/oauth2/token címre, és adja át hitelesítőadat-párját a client_id illetve client_secret paraméterek értékeként:

curl \
  --location 'https://surviot.auth.eu-central-1.amazoncognito.com/oauth2/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_id=<client_id>' \
  --data-urlencode 'client_secret=<client_secret>'

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/x-www-form-urlencoded");

const urlencoded = new URLSearchParams();
urlencoded.append("grant_type", "client_credentials");
urlencoded.append("client_id", "<client_id>");
urlencoded.append("client_secret", "<client_secret>");

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: urlencoded,
  redirect: "follow"
};

fetch("https://surviot.auth.eu-central-1.amazoncognito.com/oauth2/token", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

A hozzáférési tokenek érvényességei ideje 1 óra. Az érvényességi idő lejártát követően a token nem használható. Az API-hoz való hozzáféréshez új token beszerzésére van szükség.

Alkalmazásengedélyek (scope-ok)

Az sikeres OAuth 2.0-hitelesítés eredményeképp megkapott hozzáférési tokenje az alábbi jogkörökkel rendelkezhet a SURVIOT beállításaitól függően:

Jogkör

Leírás

api:read

Olvasási hozzáférés a SURVIOT-projektje adataihoz

api:write

Írási hozzáférés a SURVIOT-projektje adataihoz

A hozzáférési tokenben a jogköreit előtagként az ön SURVIOT-projektje azonosítójával látjuk el, így a jogkörök a com.surviot.projektnév/api:read alakot kapják.

A SURVIOT API használata

Hozzáférési tokenje birtokában megkezdheti a SURVIOT API használatát.

Személyazonosságát az Authorization HTTP-fejlécben megadott hozzáférési tokenje segítségével igazolhatja.

Kezdésképp kérdezze le mérési helyeit az API segítségével:

curl \
  --location 'https://<projektnév>.surviot.com/api/locations?time=1w' \
  --header 'Authorization: Bearer <access_token>'

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <access_token>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://<projektnév>.surviot.com/api/locations?time=1w", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

API dokumentáció

Az API-n keresztül elérhető funkciók dokumentációjáért keresse fel az API-dokumentáció oldalt.

PreviousSzójegyzék NextAPI-dokumentáció

Last updated 1 year ago