Autentykacja

Jak zacząć

Aby skorzystać z Callapi, w pierwszym kroku należy utworzyć konto w panelu https://ssl.vpbx.pl

Po prawidłowym założeniu konta VPBX, należy wygenerować konto API, klikając na link Dostęp do API -> Konta API

Logowanie i Token JWT

# Przykład autentykacji z wykorzystaniem cURL:
curl --header "Content-Type: application/json" \
--request POST \
--data '{"username": "valid_username", "password": "valid_password"}' \
https://api.vpbx.pl/api/v1/login

CallAPI / VPBX używają standardu JWT do autentykacji zapytań wysyłanych do platformy. Po wysłaniu poprawnego użytkownika i hasła na poniższy URL, system zwróci token JWT, który będzie używany w późniejszej komunikacji z systemem.

Token należy wysyłać w każdym następnym zapytaniu w nagłówku Authorization. Proces jest opisany w rfc6749.

Otrzymany token jest ważny przez czas określony w odpowiedzi, więc nie ma potrzeby generowania nowego, do czasu jego wygaśnięcia.

Przykład odpowiedzi autentykacji:
{
    "result": "OK",
    "expire": "2021-08-11T15:18:53Z",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAoMS0Iiwi"
}

Przykład błędnej autentykacji:
{
    "error": "incorrect Username or Password",
    "result": "error"
}

Parametry zapytania

Odpowiedź - Pomyślna autentykacja

Odpowiedź - Błędna autentykacja