SDK Reference
Authentication (SDK)
The auth module lets you authenticate developers programmatically — useful if you are building your own dashboard or tooling on top of SettleSettle.
For most SDK use cases (tracking events, wallet operations, payments) you only need your App API Key. The auth module is for developer account operations.
Login#
typescript
const auth = await settle.auth.login({
email: 'dev@example.com',
password: 'securepassword',
})
console.log(auth.accessToken) // JWT — valid for 15 minutes
console.log(auth.refreshToken) // Opaque token — valid for 7 daysRefresh Token#
Access tokens expire after 15 minutes. Use your refresh token to get a new pair without requiring the developer to log in again.
typescript
const auth = await settle.auth.refresh({
refreshToken: 'your_refresh_token_here',
})
// Returns a fresh { accessToken, refreshToken }
// The old refresh token is immediately revokedRefresh tokens rotate on every use. Once you call
refresh(), the token you passed in is permanently revoked. Store the new one immediately.Logout#
typescript
await settle.auth.logout({
refreshToken: 'your_refresh_token_here',
})
// The refresh token is revoked — the developer is fully logged out