Skip to main content

Glossary

Terms used across all platform docs.

TermWhat it isWho creates itWhen you use it
API keySecret identifying your appAzeoo team (contact)initialize(apiKey)
SDK Secret KeyHMAC key for signing User JWTsAzeoo team (provided with API key)Your backend β€” Creating the User JWT
SDK tokenShort-lived token for SDK backend callsSDK (after successful initialize)Internal; you rarely touch it
User JWTToken identifying the logged-in user, signed by your backend with the SDK Secret KeyYour backend β€” see Creating the User JWTconnect / connectUser
Profile idAzeoo user id stringReturned by connectStore if your app needs to reference the user
ConnectorOptional link to resamania2 / deciplusConfigured on API key in Client Platforminitialize options when key has connectors

initialize vs connect​

initializeconnect
PurposeStart SDK engine, exchange API keyAttach logged-in user
UserNoneRequired (JWT + profile)
Call whenApp start (or after dispose)After your login flow
Call again whenAPI key or global config changesUser switches account

Common mistakes​

MistakeFix
Passing userId into connectPass only JWT + gender + height + weight; id goes inside the JWT payload
Using test JWT in productionUse your backend-issued JWT signed with the SDK Secret Key
Showing SDK UI before connectWait for connect success
Calling initialize on every screenOnce per process (unless you dispose)
Confusing API Key with Secret KeyAPI Key goes in initialize(); Secret Key is used by your backend to sign JWTs