Introdução

Visão Geral

Bem vindo à documentação da API AllPost.

Nossa API é baseada nos princípios REST JSON. Através de um cliente HTTPS, a integração pode ser desenvolvida em qualquer linguagem de programação. Todas as requisições e respostas utilizam o formato JSON, seguindo os padrões REST para operações de leitura (GET), criação (POST), atualização (PUT) e exclusão (DELETE) de recursos.

Url: https://www.allpost.com.br/api

Limite de Requisições

A API possui limite de requisições por segurança, que é diferente para cada método e endpoint. O limite é contabilizado por minuto e pode sofrer alterações conforme sua necessidade.

Caso o limite seja ultrapassado, a API retornará o código HTTP 429 com a mensagem "Limite de requisições ultrapassada". Aguarde o período de um minuto antes de realizar novas requisições ao mesmo endpoint.

Padrões e Formato dos Dados

Todas as requisições e respostas da API seguem os padrões abaixo. É fundamental que sua integração respeite esses formatos para garantir a comunicação correta com a plataforma.

Autenticação

Registre-se como desenvolvedor. Clique aqui para criar sua conta.

Dentro do painel de administração, clique no ícone "+" no canto superior direito e crie seu aplicativo.

Caso queira utilizar o Auth 2.0 informe a URL de redirecionamento após instalação. Os Tokens da loja estarão disponíveis no painel administrativo ou no endpoint GET - api/v1/autenticacao/{codigoLoja}

Link Instalação da sua Aplicação: para disponibilizar a instalação do seu aplicativo no seu ambiente utilize como padrão a url https://www.allpost.com.br/SG/app/autoriza/{Código do Aplicativo}

Tipos de Token API

Existem 2 tipos de Token na API AllPost, cada um com finalidade específica:

Token da Aplicação: Utilizada apenas para Autenticação. Nos endpoints GET Autenticação e POST Webhook. Este token identifica sua aplicação perante a plataforma.

Token API: Utilizada para realizar as demais integrações. É um token vinculado à loja (pedido, produto, transportadora, etc). Existem limites de requisições por método e endpoint.

Suas chaves são SECRETAS e não devem ser compartilhadas com terceiros.

Bearer Authentication

Bearer authentication (também chamada de autenticação por token) é um esquema de autenticação HTTP que envolve tokens de segurança. O nome "Bearer authentication" pode ser entendido como "dar acesso ao portador deste token".

O cliente deve enviar este token no cabeçalho Authorization ao realizar qualquer requisição autenticada.

Authorization: Bearer {seu_token}

Exemplo de conexão em PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.allpost.com.br/api/v1/filial',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer SEU_TOKEN_AQUI'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Códigos de Retorno (HTTP Status)

A API utiliza códigos HTTP padrão para indicar o resultado de cada requisição. Abaixo estão os códigos possíveis e seus significados:

Integração com IA (MCP)

✅ O AllPost possui um servidor MCP oficial.

O Model Context Protocol (MCP) permite que IAs como Claude, ChatGPT, Cursor e Kiro consultem a documentação da API AllPost diretamente durante o desenvolvimento. O servidor MCP é distribuído junto com a documentação e roda localmente na máquina do desenvolvedor via stdio (stdin/stdout), seguindo a especificação JSON-RPC 2.0.

Compatível com Kiro, Cursor, VS Code, Claude Desktop, Windsurf e qualquer IDE/agente com suporte ao protocolo MCP.

Download e Instalação

O servidor MCP está disponível na pasta api/doc/mcp/ do repositório da documentação.

Repositório: https://www.allpost.com.br/api/doc/mcp/

1. Certifique-se de ter o Node.js (v18+) instalado na sua máquina.
2. Baixe ou clone a pasta api/doc/mcp/ e instale as dependências:
   Copy

   cd api/doc/mcp
   npm install

3. Adicione a configuração no arquivo MCP da sua IDE:
   Copy

   {
     "mcpServers": {
       "allpost-api": {
         "command": "node",
         "args": ["caminho/para/api/doc/mcp/index.js"]
       }
     }
   }

Ferramentas disponíveis

Onde configurar por IDE

Especificação Técnica do MCP

MCP Operacional (Chamadas Reais)

🔧 Servidor MCP para operações reais na API

Além do MCP de documentação, o AllPost oferece um MCP operacional que executa chamadas HTTP reais na API — criar pedidos, consultar cotações, gerenciar filas — diretamente via protocolo MCP. Requer autenticação com token Bearer.

O MCP operacional está disponível na pasta api/doc/mcp-operacional/.

Configuração

Adicione as variáveis de ambiente com os tokens da loja:

• ALLPOST_TOKEN — Token API da loja (usado para pedidos, fila, transportadoras, webhook, etc)
• ALLPOST_TOKEN_COTACAO — Token de Cotação da loja (usado para criar e consultar cotações)

Importante: O MCP operacional não utiliza o Token da Aplicação. Utilize sempre os tokens vinculados à loja que deseja operar. Ambos os tokens são obtidos via endpoint GET api/v1/autenticacao/{codigoLoja}.

{
  "mcpServers": {
    "allpost-operacional": {
      "command": "node",
      "args": ["caminho/para/api/doc/mcp-operacional/index.js"],
      "env": {
        "ALLPOST_TOKEN": "SEU_TOKEN_API_AQUI",
        "ALLPOST_TOKEN_COTACAO": "SEU_TOKEN_COTACAO_AQUI"
      }
    }
  }
}

Tools Operacionais (10 tools)

Diferença entre os dois MCPs