> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API Collection

> Explore a API Yampi de forma prática com nossa API Collection pronta para Postman e outras ferramentas compatíveis.

## Visão geral

Nós preparamos uma API Collection com todos os endpoints documentados. Com ela, você pode importar toda a estrutura da API, incluindo requisições, parâmetros e exemplos de payloads, eliminando a necessidade de configuração manual.

<Tip>
  Além do **Postman**, também é possível importar esta Collection em **Insomnia**, **Hoppscotch** ou **Thunder Client** (VS Code).
</Tip>

***

## Download da Collection

Disponibilizamos duas versões da Collection, cada uma configurada para um tipo de autenticação.

* **Versão: Autenticação via Credenciais** - Ideal para testes rápidos e integrações diretas usando as credenciais de API: `Alias`, `User Token` e `User Secret Key`.

* **Versão: Autenticação via OAuth 2.0** - Ideal para **Parceiros Tech Yampi**. Inclui scripts para gerenciar o fluxo de autorização OAuth 2.0 de ponta a ponta.

Escolha a que se encaixa melhor no seu uso.

<CardGroup>
  <Card title="🔑 Autenticação por Credenciais" href="https://www.dropbox.com/scl/fi/jyt27ik1ahkce21hyarlo/CollectionApiYampiCredenciais.json?rlkey=f4kyh0dtyzwe3gginyejdm5hz&st=n4ta7s9s&dl=1" download="CollectionApiYampiCredenciais.json" arrow="true">
    Collection configurada para uso com **Alias**, **User Token** e **User Secret Key**.
  </Card>

  <Card title="🔐 Autenticação via OAuth2.0" href="https://www.dropbox.com/scl/fi/aweiogfpwl1h9adn9ysyb/CollectionApiYampiOAuth.json?rlkey=68iijer3ftb3wtonc4bpy0c40&st=toqv10wq&dl=1" download="CollectionApiYampiOAuth.json" arrow="true">
    Collection preparada para o fluxo completo de autenticação com **OAuth2.0**.
  </Card>
</CardGroup>

***

## Como importar a Collection no Postman

<Steps>
  <Step title="Baixe a Collection">
    Escolha e baixe o arquivo `.json` da Collection desejada (Credenciais ou OAuth2.0).
  </Step>

  <Step title="Importe o arquivo no Postman">
    Clique em **Import** → **File** → selecione o arquivo `.json` baixado.
  </Step>

  <Step title="Verifique a Collection">
    A Collection aparecerá na sua barra lateral esquerda.
  </Step>
</Steps>

<Warning>
  Antes de tudo, é preciso configurar as variáveis da Collection. Cada versão possui variáveis específicas para autenticação (detalhadas abaixo).
</Warning>

***

## Configuração das variáveis

<AccordionGroup>
  <Accordion title="🔑 Versão Credenciais (Alias, User Token e User Secret Key)">
    Abra a Collection → aba **Variables** e configure:

    * **Alias** → valor disponível no painel Yampi em **Perfil > Credenciais de API**.
    * **User-Token** → valor disponível no painel Yampi em **Perfil > Credenciais de API**.
    * **User-Secret-Key** → valor disponível no painel Yampi em **Perfil > Credenciais de API**.

    <Check>
      Com essas variáveis configuradas, todas as requisições já estarão autenticadas automaticamente e prontas pra uso.
    </Check>
  </Accordion>

  <Accordion title="🔐 Versão OAuth2.0">
    Abra a Collection → aba **Variables** e configure:

    * **Partner-Client-ID** → `client_id` do seu app no painel do parceiro tech Yampi.
    * **Redirect\_URI** → URI de redirecionamento cadastrada no app.
    * **Access-Token** → deixe em branco no primeiro uso.
    * **Refresh-Token** → deixe em branco no primeiro uso.
    * **Token-Expires-At** → deixe em branco no primeiro uso.
    * **AuthCode** → deixe em branco no primeiro uso.
    * **Code\_Verifier** → deixe em branco no primeiro uso.
    * **Code\_Challenger** → deixe em branco no primeiro uso.

    <Steps>
      <Step title="Inicie a autorização">
        Execute a request **Iniciar Autorização (gerar e abrir URL)** e copie a `url` que foi gerada e salva na variável `AuthorizeURL` em **Variables**.
      </Step>

      <Step title="Autorize no navegador">
        Abra a URL, faça login, autorize e copie a URL de redirect recebida.
      </Step>

      <Step title="Cole a URL de redirect">
        Cole a URL de redirect reciba no body da request **OAuth2 - Colar URL de Redirect (capturar código)** e execute-a → isso salva **AuthCode** e **Alias** automaticamente.
      </Step>

      <Step title="Troque o código por token">
        Execute a request **OAuth2 - Trocar Código por Token** → isso gera e salva automaticamente **Access-Token** e **Refresh-Token**.
      </Step>
    </Steps>

    <Check>
      Feito, todas as requisições já estarão autenticadas automaticamente e prontas pra uso.
    </Check>
  </Accordion>
</AccordionGroup>

***

## Verificação rápida

<Note>
  Recomendamos testar alguma request, como por exemplo **GET `/catalog/brands`** logo após configurar as variáveis. Se o retorno for `200 OK`, a configuração foi um sucesso!
</Note>

Se tiver dúvidas sobre o uso da Collection ou quiser se aprofundar no ecossistema da Yampi, junte-se à nossa Comunidade Yampi Dev no Discord:

<Card title="Comunidade Yampi Dev" icon="discord" href="https://discord.gg/n895jAtW3J" horizontal>
  Faça parte da nossa comunidade de desenvolvedores.
</Card>