Kakao
OAuth 2.0 provider for Kakao.
Also see the OAuth 2.0 guide.
Initialization
import { Kakao } from "arctic";
const kakao = new Kakao(clientId, clientSecret, redirectURI);
Create authorization URL
import { generateState } from "arctic";
const state = generateState();
const scopes = ["account_email", "profile"];
const url = kakao.createAuthorizationURL(state, scopes);
Validate authorization code
validateAuthorizationCode()
will either return an OAuth2Tokens
, or throw one of OAuth2RequestError
, ArcticFetchError
, or a standard Error
(parse errors). Kakao returns an access token, its expiration, and a refresh token.
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await kakao.validateAuthorizationCode(code);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
const code = e.code;
// ...
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
const cause = e.cause;
// ...
}
// Parse error
}
The refresh token expiration is returned as refresh_token_expires_in
.
const tokens = await kakao.validateAuthorizationCode(code);
if (
"refresh_token_expires_in" in tokens.data &&
typeof tokens.data.refresh_token_expires_in === "number"
) {
const refreshTokenExpiresIn = tokens.data.refresh_token_expires_in;
}
Refresh access tokens
Use refreshAccessToken()
to get a new access token using a refresh token. Kakao returns the same values as during the authorization code validation. This method also returns OAuth2Tokens
and throws the same errors as validateAuthorizationCode()
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await kakao.refreshAccessToken(accessToken);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
}
// Parse error
}
Get user profile
Use the /user/me
endpoint.
const response = await fetch("https://kapi.kakao.com/v2/user/me", {
headers: {
Authorization: `Bearer ${accessToken}`
}
});
const user = await response.json();