Como obter e usar a chave da API do Etsy

O que é a API do Etsy?

O Etsy fornece uma API pública para obter e atualizar dados da plataforma. Qualquer API permite que desenvolvedores criem aplicativos com base em dados exclusivos e opções de um programa ou site. Da mesma forma, os desenvolvedores usam a API do Etsy para criar integrações para vendedores e compradores.

Como obter a chave da API do Etsy

Obter acesso à API web do Etsy não requer muito tempo ou esforço. Primeiro, você precisa acessar o site da comunidade de desenvolvedores do Etsy, onde pode começar a criar seus próprios aplicativos e integrações usando sua chave de API exclusiva. Siga este tutorial da API do Etsy abaixo para saber como acessar essa interface de programação.

• Passo 1 – Criar uma conta

  Vá para o site da Comunidade de Desenvolvedores do Etsy e registre uma nova conta ou faça login com uma existente.

  

  Você pode se registrar usando seu endereço de e-mail ou continuar com sua conta do Google, Facebook ou Apple.
• Passo 2 – Ajustar configurações de segurança

  Antes de criar seu primeiro aplicativo, o serviço requer a configuração de autenticação em duas etapas.

  

  Siga o link e você será redirecionado para a página de parâmetros de segurança.

  

  Você pode escolher entre várias opções: instalar um aplicativo Google Authenticator em seu dispositivo móvel para confirmar seu acesso com seu próprio código de confirmação definido através do aplicativo. Após clicar nesta opção, você será oferecido para baixar o aplicativo e conectá-lo ao portal de desenvolvedores do Etsy via digitalização de código QR.

  

  Você também pode escolher a verificação via chamada telefônica ou SMS. Ao escolher esta opção, você deve inserir seu número de telefone no campo correspondente. Após clicar em Avançar, você receberá um código SMS ou uma chamada telefônica automática, dependendo da opção que você escolher.

  

• Passo 3 – Criar um aplicativo

  Após ajustar os requisitos de segurança, você pode começar a criar seu primeiro aplicativo. Primeiro, você precisa preencher o formulário para descrever seu aplicativo prospectivo.

  

  Complete o Captcha e pressione Ler Termos e Criar Aplicativo.

  

  Você será oferecido para ler os Termos e Condições da API do Etsy no popup. Familiarize-se com o documento para estar ciente dos requisitos e restrições ao usar a interface de programação. Marque a caixa e pressione Criar Aplicativo.

  

• Passo 4 – Obter suas credenciais da API

  Depois de concordar com os termos e condições, você terá acesso à sua chave de API e segredo.

  

  Lembre-se de manter suas credenciais da API em segredo e não mostrá-las ou enviá-las a terceiros.

Como usar a API do Etsy

Quando você cria um aplicativo pela primeira vez, ele possui um Acesso Provisório padrão aos serviços do Etsy durante o processo de desenvolvimento. O Acesso Provisório apresenta as seguintes funções:

• Acesso de leitura a quaisquer recursos abertos e não autenticados, como Lojas e Tesourarias, por exemplo.
• Acesso autenticado (leitura e escrita) aos dados pertencentes ao proprietário do aplicativo. Este acesso oferece a oportunidade de ler dados pessoais como Recibos e Faturamento, e também criar, editar ou excluir Listagens de uma loja. Se necessário, você pode solicitar acesso para um pequeno grupo de usuários de teste além do proprietário do aplicativo.

O Etsy também oferece Acesso Total, que oferece a opção de acesso autenticado a dados ilimitados de membros do Etsy. Se a integração que você está desenvolvendo não precisar de privilégios como esses, você pode apenas usar o aplicativo no modo provisório.

Se você ainda deseja ter acesso total para o seu aplicativo, você deve primeiro usar o Acesso Provisório para desenvolver o aplicativo e fazê-lo funcionar corretamente e depois verificar se você se encaixa nos requisitos da plataforma para Acesso Total.

Exemplos da API do Etsy

API de avaliações do Etsy

A plataforma Etsy possui um sistema de Feedback que permite que compradores e vendedores deixem feedback um para o outro sobre transações específicas no Etsy. Ela fornece vários métodos para encontrar tipos específicos de feedback disponíveis na plataforma. Eles são, por exemplo, findAllUserFeedbackAsAuthor, findAllUserFeedbackAsBuyer, findAllUserFeedbackAsSeller, e muitos outros.

Aqui está um exemplo de um método findAllFeedbackFromBuyers, que permite que você obtenha e use seu feedback dos clientes.

Se você está procurando maneiras de exibir avaliações de clientes de sua loja Etsy, experimente um Widget de Avaliações pronto!

API de pagamento do Etsy

Pagamento e API de Transações representam uma parte das Ferramentas para Vendedores do Etsy. Todas as vendas e compras feitas por meio da plataforma Etsy são divididas em 3 fontes principais: Pedidos, Recibos e Transações. E a API de Pagamento representa um Pagamento feito com Pagamentos Etsy.

API de listagem do Etsy

As Listagens do Etsy são itens disponíveis para venda. Cada Listagem está conectada a um Usuário e a uma Loja (Usuário que possui esta Loja). As Listagens apresentam preço e quantidade associados a elas, e quando são vendidas, um proprietário da loja deve renovar os itens antes que possam ser vendidos novamente. Ela apresenta métodos para encontrar e recuperar listagens de várias categorias, e também para criar e excluir listagens. Essas categorias incluem: Ativo, Interessante, Tendência, Recibo e outras Listagens. API de Listagem do Etsy pode obter itens de vendedor com o método findAllShopListingsActive, que encontra todas as Listagens ativas pertencentes a uma loja.

Documentação da API do Etsy

O site da comunidade de desenvolvedores do Etsy oferece uma seção de Documentação desenvolvida para seus membros. Há um guia Básico para aqueles desenvolvedores que são novos na interface de programação do Etsy para ajudá-los a começar a trabalhar com ela. A seção única do portal da API do Etsy é a seção de Discussão. Todos podem participar da discussão para pedir ajuda e compartilhar sua experiência e casos.

FAQ