Referência API

Autenticação

Cabeçalhos de chaves API, gerenciamento de segredos, permissões e rotação.

Modelo de credenciais

As chaves API para MakePay são criadas na área do desenvolvedor MakeCrypto e estão limitadas a um computador. Cada chave possui um ID público e um segredo. O segredo é salvo como um hash e exibido apenas uma vez após ser criado.

Cabeçalho	Valor	Notas
`x-makecrypto-key-id`	ID da chave API MakePay	Começa com `mk_makepay_` para as APIs de pagamento MakePay.
`x-makecrypto-key-secret`	Segredo API de uso único	Exibido apenas quando a chave é criada. Armazene-o no gerenciador de segredos do servidor.

Criando chaves API

Usuários autenticados com permissão settings.manage podem criar chaves no portal ou no caminho de integração da equipe.

Utilize o caminho de descoberta empresarial do usuário autenticado quando uma ferramenta do portal precisar exibir os computadores disponíveis para o usuário atual:

GET /api/partner/v1/companies

A empresa retornada id é usada apenas para rotas de painel e gerenciamento de chaves. As rotas de pagamento servidor a servidor MakePay resolvem a empresa a partir da chave API, portanto, não exigem um ID da empresa no URL.

POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json

{
  "name": "Production backend",
  "appSlug": "makepay",
  "allowedOrigins": ["https://merchant.example"]
}

A resposta inclui integration.key_id, integration.partner_id e integration.keySecret. Salve keySecret imediatamente.

Solicitar autenticação

Envia o ID da chave e o segredo como cabeçalhos para as rotas do link de pagamento MakePay.

x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...

O API também aceita sessões autenticadas do navegador MakeCrypto para chamadas do portal de UI. As integrações servidor a servidor devem usar cabeçalhos de chave para que as solicitações não dependam de uma sessão do usuário.

Permissões

Os caminhos de leitura aceitam qualquer membro da equipe autenticado ou uma chave API válida de MakePay. Os caminhos que modificam dados requerem settings.manage para sessões do navegador. As chaves API são tratadas como credenciais de servidor confiáveis para o computador proprietário, portanto, mantenha-as limitadas aos sistemas back-end que você controla.

Rotação e revogação

Crie uma nova chave, implante-a em seu back-end e desative ou exclua a chave antiga na área do desenvolvedor MakeCrypto. Os segredos existentes não podem ser revelados novamente após a criação.

Erros de autenticação

401 Unauthorized significa que a solicitação não possui uma sessão válida ou um par de chaves API válido.
401 Invalid MakePay API credentials significa que o ID da chave, o segredo, o escopo do produto ou o status ativado não correspondem.
403 Forbidden significa que o usuário autenticado não pode acessar o computador ou não possui a permissão necessária.
404 API key not found é retornado em caminhos de gerenciamento de chaves quando o partnerId selecionado não existe para o computador.