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

# Configure sua integração

> Gere suas credenciais de API, configure suas modalidades de envio e seus webhooks no app da Cubbo.

Você mesmo configura a integração no app da Cubbo, em [app.cubbo.com](https://app.cubbo.com/stores). Faça isso
primeiro na sua loja de testes, que a equipe de suporte da Cubbo ou o seu gerente de conta cria para você, e repita
na sua conta de produção quando ela estiver ativada. Cada conta tem suas próprias credenciais.

## 1. Crie a integração Open API

**1. Abra Integrações**

No menu superior, abra **Integrações** e clique em **Criar Integração**. Escolha **Open API**.

**2. Preencha o formulário**

**URL do Webhook** é opcional. Se você a informar, ela deve ser HTTPS, e a Cubbo envia um `POST` de teste para
verificar se ela responde. **Nota** é um rótulo opcional para sua equipe. Clique em **Criar Integração**.

![Formulário Configurar Integração Open API com URL do webhook e nota](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/open-api-form.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=b1c9646c06b3617637ddd39af922287e)

**3. Salve suas credenciais**

O app mostra seu `client_id` e seu `client_secret`. Copie os dois agora e guarde-os com segurança.

![Tela de integração criada com Client ID, Client Secret e Lojas Autorizadas](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/credentials.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=0933cfff4dd6f66b6d8080831dd16154)

Em **Lojas Autorizadas** aparecem também as lojas que essas credenciais podem acessar, por exemplo
*Estas credenciais têm acesso às lojas: 1234*. Cada número é um `store_id`: o valor que você envia em
`store_id` em pedidos, produtos, inventário e nos demais endpoints de loja. Se aparecer mais de uma loja, as
mesmas credenciais servem para todas; troque o `store_id` para escolher a loja.

> [!WARNING]
>
> O `client_secret` é exibido apenas uma vez. Se você perdê-lo, precisa regenerar as credenciais, e as anteriores param
> de funcionar imediatamente.

Use essas credenciais com `POST /v1/auth/token`. Veja [Autenticação](https://developers.cubbo.com/pt-BR/guides/authentication.md).

## 2. Gerencie a integração

Sua integração Open API aparece em **Integrações** como um cartão. Nele você pode:

* **Ativar ou desativar** a integração com o botão. Enquanto ela estiver desativada, a Cubbo não processa nenhuma
  criação ou atualização vinda dela.
* Abrir **Modalidade de Envio** para configurar suas modalidades de envio. O selo indica se já estão configuradas.
* Abrir **Configurar Webhooks** para definir para onde a Cubbo envia os eventos. O selo indica se estão configurados
  ou com erros.
* **Regenerar Credenciais** quando um segredo for perdido ou exposto. As credenciais atuais param de funcionar
  imediatamente.

![Cartão da integração Open API com modalidades de envio, webhooks e regenerar credenciais](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/integration-card.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=8caa6d61ccea1b68a0cbbbda54b8c9df)

## 3. Configure as modalidades de envio

Cada pedido que você cria precisa indicar como será enviado. Você faz isso com `shipping_line_code` em
`POST /v1/orders`: o valor é o nome de uma modalidade de envio da sua integração. A Cubbo escolhe a transportadora
com a configuração de envio atribuída a essa modalidade.

![Página de modalidades de envio da integração com o botão de pontos de retirada](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/shipping-methods.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=6cf4375c4f3ccdf778666fcda442cca6)

**1. Crie uma configuração de envio**

Clique em **Criar configuração de envio** e preencha:

* **Nome da configuração**.
* **Tipo de destino**: Nacional, Internacional ou Retirada.
* **Preferência de entrega**: melhor preço escolhe a transportadora mais econômica; melhor serviço escolhe a
  entrega mais rápida ao melhor preço.
* **Permitir zonas estendidas**: se o envio para áreas remotas, que podem ter cobrança adicional, é permitido. A Cubbo
  considera esse custo ao selecionar a transportadora.
* **Transportadoras elegíveis**: as transportadoras que essa configuração pode usar, agrupadas por nível de
  serviço.

![Janela Criar configuração de envio com tipo de destino, preferência de entrega, zonas estendidas e transportadoras elegíveis](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/create-shipping-configuration.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=26123b5ab1224495675558adea5b7506)

**2. Adicione suas modalidades de envio**

Clique em **Criar modalidade de envio**. Em **Modalidade de Envio de Integração**, digite o nome exato que você
enviará como `shipping_line_code`, por exemplo `standard` ou `express`. Seus pedidos devem enviar exatamente
este nome: maiúsculas e minúsculas são diferenciadas e os espaços contam, então `Express` e `express` são
modalidades diferentes. Escolha o **Tipo de modalidade de envio**:

| Tipo | Use para |
| - | - |
| Nacional | Envios dentro do país. |
| Internacional | Envios para outros países. |
| Pagamento Contra Entrega | Envios nacionais pagos na entrega. |
| Retirada | Envios externos com etiqueta própria. |

![Janela Adicionar Modalidade de Envio com o nome e o tipo da modalidade](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/add-shipping-method.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=661c3128a9e98c7765e98e419f7a748a)

**3. Atribua uma configuração a cada modalidade**

Na lista de modalidades de envio, atribua uma das suas configurações de envio a cada modalidade. A Cubbo a usa
para selecionar automaticamente a melhor transportadora.

> [!TIP]
>
> Ative **Pontos de Retirada** na mesma página se você oferece click and collect. Veja os endpoints de Click and collect
> na referência da API.

## 4. Configure os webhooks

Clique em **Configurar Webhooks** no cartão da integração. Ative cada webhook de que você precisa e informe a URL:

| Webhook | Eventos que recebe |
| - | - |
| Pedidos | `orderUpdated`, `orderFulfilled`, `shippingUpdated` |
| Inventário | `inventoryMovement`. Só envia enquanto o webhook de pedidos estiver ativo. |
| Remessas de estoque | `replenishmentCreated`, `replenishmentScheduled`, `replenishmentStatus` |

![Tela Configurar Webhooks com os webhooks de pedidos, inventário e remessas de estoque, e o segredo compartilhado](https://mintcdn.com/cubbo/RGfmvgvbM1HVXepF/images/setup/configure-webhooks.png?fit=max\&auto=format\&n=RGfmvgvbM1HVXepF\&q=85\&s=351907fea5d35cfa00ed065237ee5b1d)

Na mesma tela:

* **Headers Personalizados** adiciona headers fixos a cada requisição de webhook, por exemplo uma API key do seu endpoint.
* **Testar** envia uma requisição de teste. Passa quando sua URL responde `200`.
* **Segredo Compartilhado do Webhook** é a chave para verificar a assinatura. Clique em **Ver segredo** para copiá-la.
* **Regenerar segredo compartilhado do webhook** invalida o segredo atual. Atualize-o no seu sistema depois de salvar.

As URLs devem usar HTTPS e um nome de domínio; endereços IP são rejeitados. O cartão da integração mostra se cada
webhook está funcionando e quando foi a última entrega bem-sucedida.

Veja [Webhooks](https://developers.cubbo.com/pt-BR/guides/webhooks.md) para os eventos, os payloads e a verificação da assinatura.

## 5. Passe para produção

Quando terminar todos os seus testes na loja de testes, peça ao seu gerente de conta para ativar sua conta de
produção. Repita estes passos nela: você recebe novas credenciais e um novo `store_id`, e configura de novo as
modalidades de envio e os webhooks. Depois troque as credenciais e o `store_id` na sua integração para começar a
operar.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.