Guia
Autenticação e chaves
Toda chamada (exceto /v1/status) é autenticada por uma chave de API enviada no cabeçalho Authorization.
Enviando a chave
Use o esquema Bearer: a palavra Bearer, um espaço e a chave completa.
| Cabeçalho | Valor |
|---|---|
Authorization | Bearer mpg_live_XXXXXXXXXXXX_YYYY… |
RequisiçãoTestar ▸
curl -X GET "https://apimapogos.sixinformatica.com/v1/me" \
-H "Authorization: Bearer $MAPOGOS_API_KEY"<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/me');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($resposta['sucesso']) {
print_r($resposta['dados']);
} else {
echo $resposta['erro']['mensagem'];
}const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/me', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
},
});
const json = await resposta.json();
if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);import os, uuid, requests
resposta = requests.request(
"GET",
"https://apimapogos.sixinformatica.com/v1/me",
headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])Ciclo de vida da chave
| Ação no painel | Efeito imediato |
|---|---|
| Criar | Gera a chave (exibida uma única vez) com as permissões escolhidas |
| Editar permissões | Vale a partir da próxima chamada, sem trocar a chave |
| Suspender / Reativar | Suspensa responde 401 chave_suspensa até ser reativada |
| Regenerar | Cria uma chave nova; a anterior para de funcionar na hora |
| Revogar | Definitivo: 401 chave_revogada e webhooks desativados |
| Expiração | Após a data, 401 chave_expirada |
Trocando a chave sem parar a integração
- Combine uma janela de manutenção curta.
- No painel, clique em Regenerar e copie a nova chave.
- Atualize a variável
MAPOGOS_API_KEYno servidor e reinicie o serviço. - Confirme com
GET /v1/me.
!
Suspeita de vazamento?
Regenere a chave imediatamente e revise os Logs da chave no painel (rota, IP e horário de cada chamada).
Restrições de segurança
| Recurso | Para que serve |
|---|---|
| Lista de IPs | Aceita chamadas apenas dos IPs/faixas (CIDR) informados |
| Limite por minuto | Protege a integração de laços infinitos; padrão 120/min |
| Carteiras | Restringe a chave à frota MAPOGOS, Premium ou ambas |
| CORS | Desligado por padrão — a chave é para uso servidor-a-servidor |