🌐 Api
O módulo Api é responsável por abstrair o consumo da API Pública da Uappi, oferecendo uma interface simples, tipada e pronta para uso.
⚙️ Configuração e uso
O Api já vem totalmente configurado por padrão.
Você não precisa:
- Gerenciar headers
- Controlar persistência de dados
- Implementar lógica de autenticação pública
- Países
- CEP / zipcode
- Bandeiras de cartão
countryDetaillistCardFlagslistContrieslistZipcodelistBannerslistMenulistShowcaselistTemplateSettingsaddNewsletterchangePasswordByAuthenticatedchangePasswordByCodecheckclaimGiftCardcreateAddresscreateImageProductReviewcreateInterestcreateProductReviewcreateStoreReviewdeleteAddressdeleteNewsletterdetaildetailOrderGroupgetStoreReviewByCustomerlistAddresslistCustomerHistorylistCustomerReviewlistOrderGroupslistOrderItemHistorylistProductReviewlistSalesChannelByEmaillistStoreReviewlistWalletTransactionloggoutpasswordRecoverysigninByDocumentsigninByEmailsignupupdateupdateAddressupdateDocumentupdatePrimaryAddressaddProductToWishlistdetailWishlistlistWishlistremoveProductToWishlistconfirmMfadeleteMFAloginMfamfaSetupsendMfaaddProductapplyAddressesbuydeleteProductlistDetaillistPaymentspaymentConditionspaymentTokenrecoveryselectShipmentshipmentQuoteupsellsupsertProductcreateProductCommentdeleteProductCommentgetCategoryTreegetProductByIdgetSearchgetUrllistBrandslistCategoriesTreelistProductCommentslistShipmentQuoteProductlistVariationaddCouponapplyPointapplyWalletdeleteCoupondeletePointdeleteWalletgetPromotionalForecastlistPairOffersdetailOrderPaymentCodecontactoauthRedirectfacebookAddPaymentInfofacebookAddToCartfacebookInitiateCheckoutfacebookPageViewfacebookPurchasefacebookSearchfacebookViewContentusePublicApi: função base usada por todos os métodos, para chamar endpoints que o SDK ainda não encapsulagetCookieNamecaptureCookieName- Tipagem automática com TypeScript
- Persistência de dados já configurada
- Organização clara por domínio
- Redução de código boilerplate
Basta importar e utilizar.
💡 Exemplo de uso
1import { Api, type ApiTypes } from '@uappi/public-sdk';2import { ref, onMounted } from 'vue';34const banners = ref<ApiTypes.Banners | null>(null);56onMounted(async () => {7 banners.value = await Api.customization8 .listBanners('home')9 .catch(() => null);10});🧱 Estrutura dos recursos
Os endpoints da API são organizados por domínios de responsabilidade, facilitando o entendimento e manutenção.
🌍 common
Responsável por dados utilitários e complementares da API.
Exemplos:
🎨 customization
Responsável por dados de personalização da loja.
👤 customer
Responsável pelas operações relacionadas ao cliente.
Lista de desejos:
Autenticação em duas etapas (MFA):
🛒 cart
Responsável pelas operações do carrinho e checkout.
🛍️ product
Responsável pelos dados de produtos e navegação.
🎁 promotional
Responsável por promoções e benefícios.
📦 order
Responsável por consultas públicas de pedido.
📩 notify
Responsável por ações de contato.
🔌 thirdParty
Responsável por integrações externas, como autenticação social e eventos do Facebook (API de Conversões).
🔧 Utilitários
Exportados na raiz do Api:
🎯 Benefícios
Ao utilizar o módulo Api, você tem: