Referência API

API do portal do cliente

Gera URLs assinadas do portal do cliente MakePay para clientes salvos.

Gerar um link do portal

Cria um link do portal do cliente MakePay a partir de um perfil de cliente MakePay salvo. Gere o link somente quando o cliente ou lojista inserir o faturamento e depois redirecione ou abra o URL retornado.

POST /api/partner/v1/makepay/customers/{customerId}/portal

customerId aceita o UUID salvo do cliente ou o UID do cliente. O corpo da solicitação está vazio.

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Autenticação

As integrações de servidor são autenticadas com uma chave API de MakePay. As sessões do navegador podem chamar a rota do painel com escopo empresarial quando o usuário autenticado tiver settings.manage no computador selecionado. As solicitações com a chave API não passam um ID de empresa em URL porque a chave já pertence a uma empresa.

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.

Responder

A rota retorna o objeto cliente mais um link assinado em urls.customerPortal.

json

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

Parâmetros de URL assinado

O portal retornado URL possui este formato:

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}

Parâmetro	Notas
`company`	ID da conta corporativa MakeCrypto que pertence ao cliente.
`customer`	UID do cliente MakePay com escopo daquela empresa.
`expires`	Carimbo de data/hora Unix em segundos. Os links são válidos por 24 horas.
`signature`	Assinatura HMAC nos valores de versão, empresa, cliente e expiração.

MakePay verifica a assinatura e a expiração antes de fazer upload dos dados do portal. Não armazene URLs de portal permanentemente. Regenera um novo link a cada clique de botão.

Escopo do Portal

O portal exibe apenas dados que correspondem à empresa e ao cliente assinados:

Resumo do perfil do cliente e nome de exibição editável.
Histórico de pagamentos por e-mail do cliente ou ID do cliente.
Links pagos ativos ou não pagos com URLs MakePay hospedados.
Assinaturas por e-mail do cliente ou ID do cliente nos metadados.
Pausar, reativar e cancelar ações para estados de assinatura compatíveis.

E-mail, ID do cliente, PDFs, formas de pagamento, chaves de licença, mudança de plano e fluxos de retomada de assinatura cancelada não são mutáveis na primeira versão do portal.