Welcome! Guia para novos desenvolvedores: apps, mascaramento, sandbox, etc.

Olá, desenvolvedor(a) Após a aprovação do perfil (Third-Party Partner ou Registered Business Seller), é de responsabilidade do desenvolvedor acompanhar e seguir integralmente a documentação oficial da Shopee Open Platform: • Developer Guide - Onboarding do desenvolvedor, separado por tópicos de integração, explicações de fluxos e demais informações. https://open.shopee.com/developer-guide/4 • API Reference - Lista de todas APIs disponíveis atualmente e seus respectivos endpoints. Antes de chamar um endpoint, verifique se o mesmo ainda existe. https://open.shopee.com/documents/v2/v2.ams.get_open_campaign_added_product?module=127&type=1 Atentem-se, especialmente, aos anúncios publicados na Open Platform, pois os anúncios contém informações e atualizações importantes sobre a política da Open Platform e APIs: ANNOUCMENT- https://open.shopee.com/announcements?page=1&category=55 Abordaremos um breve onboarding documental: - App - App de Chat - IP Whitelist/Sensitive Data/Mascaramento de Dados - Sandbox - Autorização e Autenticação - Partner Key e Reset ______________ Permissões, APIs e Categoria do Aplicativo

A categoria selecionada durante a criação do aplicativo é o fator que determina todas as capacidades e limitações da integração, incluindo: • APIs disponíveis para utilização; • Permissões e escopos de acesso; • Funcionalidades permitidas para o aplicativo. Portanto, não existem liberações adicionais ou concessões de permissões extras em aplicativos já criados. Todas as permissões e funcionalidades são definidas exclusivamente pela categoria selecionada no momento da criação do projeto. Caso determinada API ou funcionalidade não esteja disponível para a categoria escolhida, não existe possibilidade de liberação manual, e em alguns casos pode ser necessário criar mais de um App, dependendo de sua necessidade. Anúncio: [BR] Criação de App: permissões e APIs são definidas pela categoria selecionada https://open.shopee.com/announcements/1400?category=3&is_top=false

____________ Customer Service (Chat API) Conforme política global da Shopee Open Platform, novas solicitações para aplicativos da categoria Customer Service de desenvolvedores independentes e plataformas Third-party Partner foram encerradas em 18 de novembro de 2024. (Applications for Customer Service Apps from Individual Third Parties and Third-party Partner Platforms have been closed since November 18, 2024.) Para Registered Business Sellers, a solicitação deve ser realizada através do respectivo Gerente de Contas (RM), que poderá encaminhar o caso para avaliação interna. A equipe da Open Platform não possui visibilidade nem responsabilidade sobre o relacionamento entre sellers e seus respectivos RMs. Em caso de dúvidas sobre quem é o responsável pela conta, recomendamos contato com o Atendimento ao Vendedor através do site ou aplicativo da Shopee. Anúncio: [BR] Lembrete: Política de Acesso à Chat API (Chat API) https://open.shopee.com/announcements/1430

______________ IP Whitelist/Sensitive Data/Mascaramento de Dados O acesso a dados sensíveis está diretamente relacionado às configurações de segurança da aplicação, incluindo IP Whitelist. Todo o processo de configuração deve ser realizado pelo próprio desenvolvedor dentro do aplicativo. A equipe da Open Platform não possui acesso ao ambiente da aplicação e, portanto, não realiza qualquer configuração ou alteração manual. Documentação: https://open.shopee.com/developer-guide/718 Requesting Access to Sensitive Data - How to Enable IP Address Whitelisting Anúncio: [BR] Lembrete: Acesso a Dados Sensíveis (Sensitive Data Access) https://open.shopee.com/announcements/1364 Além disso, existem cenários e status específicos em que os dados do comprador não serão disponibilizados pela API, conforme documentado em: (Passo a passo para subir a NF-e através da OpenAPI) https://open.shopee.com/developer-guide/382

______________ Sandbox (test.stable = ambiente de teste) O ambiente Sandbox (test-stable) é destinado exclusivamente para testes e validações de integração. Embora seja funcional, ele não replica integralmente o ambiente de produção e, portanto, comportamentos divergentes, limitações e instabilidades podem ocorrer. Em caso de erros relacionados à criação de pedidos de teste, recomendamos criar novos produtos e realizar novos testes utilizando diferentes categorias de itens. Em validações internas, observamos que determinados cenários podem apresentar falhas pontuais enquanto outros funcionam normalmente. Por se tratar de um ambiente de testes, podem ocorrer intermitências como: • Erros na criação de pedidos de teste: "error_sandbox_order_checkout_cart_item" "invalid product, please use another product and try again later" • Falhas em chamadas de API: "Failed to get info, please try again later" • Comportamentos inconsistentes durante fluxos de teste. Caso o comportamento persista, faça testes de isolamento, e então gere: vídeo do processo completo (sem prints cortados) e arquivo har da tentativa, abrindo ticket na Open Platform. Documentação: Sandbox Testing V2 https://open.shopee.com/developer-guide/644 ______________ Autorização e Autenticação Existem 3 etapas para concluir a autorização: gerar o link de autorização, obter autorização da(s) loja(s) e obter/renovar o access_token. Sigam a documentação oficial para utilizar as URLs e caminhos corretos e atualizados. Breve resumo: 1. Para todos os tipos de App, é necessário criar um link de autorização. O link de autorização é composto por uma URL fixa de autorização e outros parâmetros obrigatórios. 2. O timestamp utilizado para calcular o sign é válido apenas por 5 minutos. Após a expiração do timestamp e do sign, o link de autorização deixará de ser válido e será necessário gerar um novo link. 3. Os sellers podem escolher durações predefinidas (7 dias, 30 dias, 90 dias, 180 dias ou 365 dias) ou selecionar “Customize Expiration Time” para definir qualquer data de expiração dentro de 365 dias. - Aqui trata-se da expiração da autorização de integração dada pela loja na Shopee, o processo inicia-se na integradora, e o seller é apenas redirecionado para URL da Shopee para realizar o login da loja (verificar prints na documentação). 4. Após a conclusão da autorização, a página frontend será redirecionada para o redirect_uri especificado no link de autorização, juntamente com o código de autorização (code) e o ID da loja (shop_id). code = Retornado quando a chamada é bem-sucedida. Esse código é utilizado para obter access_token e refresh_token. É válido apenas uma vez e expira após 10 minutos. access_token = O access_token é um token dinâmico necessário para chamar APIs não públicas. Ele é válido por 4 horas e pode ser utilizado múltiplas vezes dentro do período de validade. refresh_token = Antes que o access_token expire, é necessário utilizar o refresh_token para chamar a API Refresh Access Token (RefreshAccessToken) e obter um novo access_token. O refresh_token é válido por 30 dias. * Após a geração de um novo access_token, o access_token anterior continuará válido por mais 5 minutos. Documentação: Authorization and Authentication https://open.shopee.com/developer-guide/20 ______________ Partner Key e Reset da Partner Key

- Sem reset automático da chave após expiração - Uma vez expirada, a plataforma não irá gerar uma nova chave automaticamente. Ao invés disso, a chave será marcada como inválida e as chamadas de API que a utilizarem serão bloqueadas - Quando o reset da Partner Key for efetuado, a nova chave será ativa imediatamente, sem a necessidade de definir um período para ativação - Será possível definir um período para expiração da chave antiga, com um máximo de 72 horas após o reset, de modo a permitir uma transição mais suave e minimizar interrupções durante atualizações de sistema. - A Partner Key continua válida por 180 dias a partir da data de geração - Não é necessário realizar a re-autorização do vendedor (a mesma tem a validade que o seller determinar, com máximo de até 365 dias) A partner key é configurada e reseta dentro do APP, em APP LIST no Console: https://open.shopee.com/console/app Anúncio: [Importante] Melhorias no reset da Open API Partner Key https://open.shopee.com/announcements/1192 ___________

Por gentileza, consulte sempre a documentação oficial da Shopee Open Platform, onde estão descritos os requisitos, limitações e comportamentos esperados de cada funcionalidade. Atenciosamente, Shopee Open Platform