BizKitHub

Identity ID

Z BizKitHub Docs, znalostní báze platformy

identityId je interní identifikátor relace, který automaticky generuje BizKitHub, když se uživatel přihlásí. Vaše aplikace musí tento identifikátor uložit do cookies a zahrnout ho do všech následných API požadavků, aby udržela autentizovanou relaci uživatele.

Jak to funguje

Tok identityId je jednoduchý a automatický. Postupujte podle těchto kroků pro implementaci správy relací ve vaší aplikaci.

  1. Přihlášení uživatele — uživatel se autentizuje prostřednictvím loginového endpointu API BizKitHub.
  2. Vytvoření relace — BizKitHub automaticky vygeneruje unikátní identityId.
  3. Uložení do cookies — vaše aplikace uloží identityId do cookies prohlížeče.
  4. API integrace — zahrňte identityId v následných API požadavcích.

Charakteristiky Identity ID

  • Bezpečné — kryptograficky generovaný identifikátor relace.
  • Časově omezené — relace vyprší po období neaktivity.
  • Spravované serverem — automaticky vytvářeno a ověřováno BizKitHubem.
  • Obnovitelné — lze obnovit prostřednictvím nové autentizace.

Příklad identity ID

Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
  • Formát: 32-znakový alfanumerický řetězec.
  • Automaticky generováno během přihlašovacího procesu.

Implementace

Krok 1: Příjem identityId při přihlášení

// Login request
const response = await fetch('https://api.bizkithub.com/api/v1/contact/login', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
apiKey: 'YOUR_API_KEY',
email: '[email protected]',
password: 'userPassword123'
})
});
const data = await response.json();
// Extract identityId from response const identityId = data.identityId; // e.g., "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg"

Krok 2: Uložení do cookies

// Store identityId in cookies
document.cookie = `identityId=${identityId}; path=/; max-age=86400; secure; samesite=strict`;
// Or using a cookie library (recommended) import Cookies from 'js-cookie'; Cookies.set('identityId', identityId, { expires: 1, // 1 day secure: true, sameSite: 'strict' });

Krok 3: Zahrnutí do API požadavků

// Get identityId from cookies
const identityId = Cookies.get('identityId');
// Include in API request const response = await fetch('https://api.bizkithub.com/api/v1/contact/profile', { method: 'GET', headers: { 'Content-Type': 'application/json' } }).then(res => res.json());
// Or in request body const response = await fetch('https://api.bizkithub.com/api/v1/contact/update', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ apiKey: 'YOUR_API_KEY', identityId: identityId, // ... other data }) });

Krok 4: Řešení vypršení platnosti relace

// Check for session expiration errors
const response = await fetch('https://api.bizkithub.com/api/v1/contact/profile', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
apiKey: 'YOUR_API_KEY',
identityId: Cookies.get('identityId')
})
});
const data = await response.json();
if (data.error === 'SESSION_EXPIRED' || data.error === 'INVALID_IDENTITY') { // Clear expired session Cookies.remove('identityId');
// Redirect to login window.location.href = '/login'; }

Nejlepší postupy

  • Ukládejte identityId bezpečně v cookies typu HTTP-only, pokud je to možné.
  • Nikdy nevystavujte identityId v klientských logách nebo chybových zprávách.
  • Vymažte identityId z cookies při odhlášení uživatele.
  • Implementujte timeout relace na straně klienta.
  • Řešte vypršení platnosti relace elegantně s novou autentizačním tokem.
  • Používejte HTTPS pro všechny požadavky obsahující identityId.

Časté chyby

  • Ukládání identityId v localStorage místo v cookies.
  • Zahrnování identityId v URL parametrech.
  • Nevyprazdňování údajů relace při odhlášení.
  • Cachování API odpovědí, které obsahují data specifická pro uživatele.
  • Ignorování chyb vypršení platnosti relace.

Použití identityId ve Swagger dokumentaci

V dokumentaci Swagger je parametr identityId popsán jako:

  • Parameter: identityId
  • Type: String
  • Description: Identita přihlášeného uživatele (z cookies vašeho frontendu)
  • Example: Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

Podívejte se na kompletní API dokumentaci pro úplnou referenci.

Související

Stránka byla naposledy upravena 24. července 2026.