Większość endpointów API wymaga autoryzacji i uwierzytelnienia. Aby poprawnie wysłać żądanie do API potrzebujemy tokenów „access_token” i „id_token”. Jak wygenerować tokeny [link]. Każdorazowo przy wywołaniu zabezpieczonego endpointa, powinno się wysyłać dwa dodatkowe nagłówki:
Authorization: Bearer {access_token}
x-id-token: {id_token}
Przykładowe wywołanie CURL:
curl -X GET \
--url 'https://api.xsale.ai/me'
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cC...' \
--header 'x-id-token: eyJodHRwczovL2Z1dHVyaXRpLnBsL3VzZXJfbWV0YWRhdGEiO...'UWAGA! Należy upewnić się, że żądania wysyłane są protokołem HTTPS. W przypadku niektórych bibliotek, wysłanie żądania pod HTTP może skutkować automatycznym przekierowaniem na HTTPS bez ponownego załączenia nagłówków.
Parametr {organizationName} w URL
Nazwę organizacji (organizationName) można sprawdzić w ustawieniach integracji REST API utworzonej w panelu xSale.
Można także odpytać endpoint https://api.xsale.ai/me zwracający informacje o użytkowniku, dla którego wygenerowany jest token.
Przykładowe dane zwrócone przez endpoint https://api.xsale.ai/me
{
"Id": 1,
"Name": "Lorem Ipsum",
"Nickname": "loremipsum",
"Email": "loremipsum@futuriti.pl",
"EmailVerified": true,
"Organizations": [
{
"Id": 1,
"ShortName": "Futuriti",
"Name": "Futuriti_bb7b2a13-84e7-4261-8550-0250op0f9b55"
}
]
}{organizationName} odpowiada polu „Name” w węźle „Organizations”.
