@elogroup-sereduc/portal-aluno-api-client
v1.1.0
Published
Cliente API centralizado para microfrontends do Portal Aluno
Downloads
63
Readme
@elogroup-sereduc/portal-aluno-api-client
Cliente API centralizado para microfrontends do Portal Aluno. Este package fornece utilitários de autenticação e uma instância configurada do axios com interceptores para gerenciamento automático de tokens.
Suporte completo a TypeScript - Inclui definições de tipos e interfaces.
Instalação
npm install @elogroup-sereduc/portal-aluno-api-client
# ou
yarn add @elogroup-sereduc/portal-aluno-api-clientUso
Usando a instância padrão do axios
import { api } from "@elogroup-sereduc/portal-aluno-api-client";
// A instância já está configurada com interceptores de autenticação
const response = await api.get("/endpoint");Criando uma instância customizada
import { createApiClient } from "@elogroup-sereduc/portal-aluno-api-client";
const customApi = createApiClient({
baseURL: "https://api.exemplo.com",
withCredentials: true,
});
const response = await customApi.get("/endpoint");Usando utilitários de autenticação
import {
getAccessToken,
saveAccessToken,
removeAccessToken,
ACCESS_TOKEN_COOKIE,
} from "@elogroup-sereduc/portal-aluno-api-client";
// Obter token
const token = getAccessToken();
// Salvar token
saveAccessToken("novo-token", 7); // 7 dias de expiração
// Remover token
removeAccessToken();Funcionalidades
- Interceptores automáticos: Adiciona automaticamente o token de autenticação nas requisições
- Refresh automático: Tenta renovar o token automaticamente quando recebe 401
- Gerenciamento de cookies: Utilitários para gerenciar o access_token em cookies
- Configurável: Permite criar instâncias customizadas do axios
Configuração
A instância padrão do axios usa window.__API_BASE_URL__ como baseURL se disponível. Caso contrário, você pode criar uma instância customizada com createApiClient().
