> ## Documentation Index > Fetch the complete documentation index at: https://knowledge.flowella.io/llms.txt > Use this file to discover all available pages before exploring further. # Developer hub: API sandbox, pedidos recentes e documentação da API > Veja os seus pedidos recentes à API do Flowella, ative ou desative a API sandbox ao nível da organização e abra guias de início rápido, documentação interativa da API, Postman e OpenAPI. O Developer hub reúne o que precisa para desenvolver sobre a [API REST do Flowella](https://knowledge.flowella.io/pt/api-reference/introduction.md). Mostra o endereço da API, um registo dos pedidos de API recentes, o interruptor da **API sandbox** ao nível da organização, guias de início rápido e ligações para a documentação da API. Para o abrir, aceda a **Settings** e depois selecione **Developer hub** no grupo **Developer**. ## Quem o pode usar | Parte do hub | Quem a pode usar | | - | - | | **API base URL**, **Quickstarts** e **Links** | Todos na organização. | | **Recent API requests** | Owners e Admins. Para outras funções, o cartão não mostra pedidos. | | **API sandbox** | Todos podem ver se está **Active** ou **Off**. Apenas Owners e Admins a podem ativar ou desativar. | | As chaves de API e aplicações de programador que as ligações abrem | Owners e Admins. Consulte [Chaves de API](https://knowledge.flowella.io/pt/settings/api-keys.md) e [Aplicações de programador](https://knowledge.flowella.io/pt/settings/developer-apps.md). | ## API base URL Este cartão mostra o endereço da API REST. Na sua integração, use `https://api.flowella.io/v1` como URL base, mesmo que o cartão mostre um endereço terminado em `/api/v1`. Consulte [URL base](https://knowledge.flowella.io/pt/api-reference/introduction.md#url-base) para saber porquê. ## Recent API requests Este cartão lista os 25 pedidos de API mais recentes feitos à sua organização com chaves de API ou tokens de acesso OAuth, do mais recente para o mais antigo. | Coluna | O que mostra | | - | - | | **Time** | Quando o Flowella recebeu o pedido. | | **Method** | O método HTTP, por exemplo `POST`. | | **Path** | O endpoint chamado. | | **Status** | O estado HTTP que o Flowella devolveu. | | **Actor** | Quem fez a chamada: `key:` seguido de um identificador para uma chave de API, ou `oauth:` seguido do client ID de uma aplicação OAuth. O identificador `key:` não é o prefixo da chave mostrado no ecrã de chaves de API. | | **Request id** | O ID do pedido, o mesmo valor que o cabeçalho de resposta `X-Request-Id`. | Os pedidos que o Flowella recusa antes de os executar não são listados. Incluem pedidos com um token em falta ou inválido, um âmbito em falta, um cabeçalho `API-Version` não suportado ou que excedem o limite de pedidos. Para ver tudo o que está associado a um pedido, como os eventos, tarefas e entregas de webhooks que originou, chame `GET /v1/requests/{requestId}` com o **Request id**. Requer o âmbito `account:read`. Consulte [IDs de pedido](https://knowledge.flowella.io/pt/api-reference/introduction.md#ids-de-pedido). ## API sandbox O cartão **API sandbox** tem um interruptor ao nível da organização para testar sem enviar nada para o WhatsApp. A etiqueta mostra **Active** quando a sandbox está ativa e **Off** quando está desativada. **Sandbox guide** abre o guia da sandbox na aplicação. Para ativar a sandbox, um Owner ou Admin marca a caixa de verificação na parte inferior do cartão. Desmarque-a para desativar a sandbox. A alteração aplica-se de imediato a toda a organização. Também pode consultar e alterar a definição com `GET /v1/sandbox` e `PATCH /v1/sandbox`, usando o corpo `{ "enabled": true }` ou `{ "enabled": false }`. Ambos requerem o âmbito `sandbox:manage`. > [!WARNING] > > A API sandbox afeta mais do que as chamadas à API. Enquanto estiver ativa, o [envio em massa](https://knowledge.flowella.io/pt/app/bulk-send.md) na aplicação e a ação **Send WhatsApp Template** nos workflows do HubSpot também deixam de chegar aos contactos. As respostas a partir da caixa de entrada e as ações do HubSpot **Send WhatsApp Message** e **Send WhatsApp Reply** continuam a enviar realmente. Desative a sandbox assim que terminar os testes. ### API sandbox e chaves de sandbox Há duas formas de usar a sandbox. A **API sandbox** ao nível da organização abrange todos os pedidos, enquanto uma [chave de sandbox](https://knowledge.flowella.io/pt/settings/api-keys.md#chaves-de-sandbox) abrange apenas os pedidos feitos com essa chave. | | **API sandbox** ao nível da organização | **Sandbox key** | | - | - | - | | Como a ativa | Um Owner ou Admin marca o interruptor aqui, ou chama `PATCH /v1/sandbox`. | Marque **Sandbox key** ao criar uma chave de API. | | Que pedidos abrange | Todos os pedidos de API na organização, de qualquer chave de API ou aplicação OAuth. | Apenas os pedidos feitos com essa chave. | | `POST /v1/messages` | Guardada no Flowella, não enviada. | Guardada no Flowella, não enviada. | | Submissão de modelos | Decisão simulada imediata. | Decisão simulada imediata. | | Envios de teste de modelos | Ignorados. | Ignorados. | | `POST /v1/templates/send` | Os destinatários são registados como concluídos, nada é enviado. | Enviado realmente. | | **Bulk send** na aplicação e a ação **Send WhatsApp Template** do HubSpot | Os destinatários são registados como concluídos, nada é enviado. | Não afetado. | ### O que muda na sandbox Quando a sandbox abrange um pedido: * `POST /v1/messages` guarda a mensagem na conversa e devolve `"sandbox": true` com `metaMessageId` definido como `null`. Nada chega ao WhatsApp e nenhum webhook `message.sent` é acionado. * A submissão de modelos com `POST /v1/templates/{id}/submit` não chega à Meta. Aprova o modelo de imediato, ou rejeita-o se o nome do modelo contiver `reject_`. Um cabeçalho multimédia cujo exemplo seja apenas um endereço web é recusado com `400 INVALID_TEMPLATE_COMPONENTS`. A decisão aparece na API e no feed de eventos, mas a página **Templates** na aplicação não muda. * A sandbox funciona na sua organização real. Os contactos, conversas e mensagens criados durante os testes são guardados como quaisquer outros e aparecem na aplicação. ### Ferramentas de teste da sandbox Estes endpoints ajudam a simular atividade. Requerem o âmbito `sandbox:manage` e funcionam quer a sandbox esteja ativa ou não, por isso use-os apenas com dados de teste. | Método | Caminho | O que faz | | - | - | - | | `GET` | `/v1/sandbox/status` | Indica se a API sandbox está ativa e devolve `sandboxKey`, que diz se a sua chave é uma chave de sandbox. | | `POST` | `/v1/test/contacts` | Cria ou atualiza um contacto a partir de `phone` e de um `name` e `email` opcionais. | | `POST` | `/v1/test/messages/{id}/simulate-status` | Adiciona ao feed de eventos um evento `message.sent`, `message.delivered`, `message.read`, `message.failed` ou `message.accepted` para uma mensagem. Envie o `status` sem o prefixo `message.`. | | `POST` | `/v1/test/webhooks/replay-event` | Adiciona ao feed de eventos um evento do `type` que escolher. | | `POST` | `/v1/sandbox/fixtures/reset` | Limpa os eventos da sandbox, as tarefas da sandbox e as decisões simuladas de modelos. `POST /v1/test/reset` faz o mesmo. | As ferramentas de teste escrevem apenas no feed de eventos (`GET /v1/events`). Não enviam webhooks nem alteram a própria mensagem. ## Quickstarts O cartão **Quickstarts** contém ligações para guias passo a passo. Cada um abre como um ficheiro Markdown num novo separador. | Guia de início rápido | O que abrange | | - | - | | Salesforce | Instalação OAuth, envio de modelos e ingestão de formulários. | | Zoho CRM | Upsert em massa de contactos e webhooks de saída. | | SurveyMonkey | Mapeamento dos dados de inquéritos e webhooks de entrada. | | Typeform | Fluxos do fornecedor Typeform e webhooks de entrada. | | n8n | Nós HTTP Request que chamam a API. | ## Links | Ligação | O que abre | | - | - | | **Interactive API docs** | A referência da API na aplicação, com esquemas de pedidos e exemplos para experimentar. Cole uma chave de API para enviar pedidos de teste. | | **Manage API keys** | [Chaves de API](https://knowledge.flowella.io/pt/settings/api-keys.md), onde cria e revoga chaves. | | **Developer apps** | [Aplicações de programador](https://knowledge.flowella.io/pt/settings/developer-apps.md), onde regista aplicações OAuth. | | **OpenAPI JSON** | O documento OpenAPI da API, que pode importar para o Postman, o Insomnia ou um gerador de código. | | **Postman collection** | Transfere `flowella-v1.postman_collection.json`. | | **Capabilities matrix (authenticated)** | `GET /v1/capabilities`, que lista os âmbitos do seu token, se a sandbox está ativa e os tipos de mensagem e categorias de modelos suportados. Requer uma chave de API com o âmbito `account:read`, por isso um separador do navegador mostra um erro de autenticação. Chame-o antes a partir do seu cliente de API. | ## Relacionado > **[Introdução à API](https://knowledge.flowella.io/pt/api-reference/introduction.md)** > > Autenticação, âmbitos, limites de pedidos e erros. > **[Chaves de API](https://knowledge.flowella.io/pt/settings/api-keys.md)** > > Crie chaves reais e de sandbox. > **[Aplicações de programador](https://knowledge.flowella.io/pt/settings/developer-apps.md)** > > Registe uma aplicação OAuth e gira as aplicações instaladas. > **[Referência de webhooks](https://knowledge.flowella.io/pt/api-reference/webhooks.md)** > > Tipos de eventos, payloads e verificação de assinaturas. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.