Tema
Glossário
Termos do contrato da API mPm+ e do modelo de vínculo recomendado no sistema parceiro.
Credenciais e ambiente
| Termo | Significado |
|---|---|
| empresa_id | Header HTTP que identifica a empresa no mPm+. Valor numérico fornecido pela operadora (ex. fictício: 9999). |
| token | Header HTTP de autenticação. Não é Bearer; vai no header token. |
| MPM_API_URL | Variável de ambiente com a URL base. Default: https://mobtef.conexaoapi.com.br. |
| app_nome | Header app_nome — nome do aplicativo/integração do parceiro. |
| app_versao | Header app_versao — versão informada pelo parceiro. |
| plataforma | Header plataforma — ex.: WEB, Android, iOS. |
| dispositivo_id / dispositivo_model / dispositivo_tipo | Headers de dispositivo; em integrações servidor-a-servidor costumam ser valores fixos (ex.: "1"). |
| FTP | Canal opcional para upload de imagens (host, porta, usuário, senha). |
Vínculo ERP ↔ mPm+
| Termo | Significado |
|---|---|
| integracao (tag) | Campo do body (ou associação) com o código interno do sistema parceiro (ex.: CAF-001). Identifica o registro no ERP. |
| mpm_integracao | Coluna local (INTEGER) recomendada em cada entidade do banco do parceiro. Guarda o ID numérico retornado/associado no mPm+. |
| pedido id | Identificador do pedido no mPm+ (campo id na lista de pedidos). O parceiro deve persisti-lo para idempotência. |
| grupo_id / unidade_id / produto_id / cliente_id / rota_id | Headers extras no PUT (e/ou campos de referência no body) com o ID mPm+ da entidade. |
| finalizadora_id / plano_id / funcionario_id | Headers no PUT de associação dessas entidades. |
| usuario_id | Em listas de funcionários, o mPm+ pode expor um ID de usuário; é o valor típico a gravar em mpm_integracao do vendedor. |
Não confundir
A tag integracao carrega o código do ERP. A coluna mpm_integracao carrega o ID no mPm+.
Entidades da API
| Termo | Endpoint | Papel |
|---|---|---|
| grupo | /mpm/grupos | Categoria / seção de produtos |
| unidade | /mpm/unidades | Unidade de medida |
| produto | /mpm/produtos | Item comercializado |
| cliente | /mpm/clientes | Cliente / consumidor |
| rota | /mpm/clientes/rotas | Rota de atendimento / entrega |
| finalizadora | /mpm/finalizadoras | Forma de pagamento (já existente no mPm+; parceiro associa) |
| plano | /mpm/finalizadoras/planos | Plano de pagamento ligado à finalizadora |
| funcionario | /mpm/funcionarios | Vendedor / usuário mobile |
| pedido | /mpm/pedidos | Pedido de venda mobile (consulta GET) |
Protocolo e respostas
| Termo | Significado |
|---|---|
| POST | Cria entidade no mPm+. Em geral envia a tag integracao. |
| PUT | Atualiza ou associa. Exige header *_id com o ID mPm+. |
| GET | Lista entidades ou pedidos (pedidos usam headers abertura / fechamento). |
| status: success | Critério usual de sucesso no JSON de resposta. |
| data[0].id | Onde tipicamente vem o ID criado após um POST bem-sucedido. |
| abertura / fechamento | Headers de período (data/hora) no GET de pedidos. |
| atualizacao | Header opcional em algumas listagens (ex.: finalizadoras). |
| Webhook | Não é obrigatório. O parceiro consulta pedidos via GET. |
Exemplos fictícios
Neste portal: TOKEN_FICTICIO, empresa_id 9999, códigos internos CAF-001, GRP-01, UN-UN.