API de Integração

Autenticação

Toda chamada envia o header X-Api-Key com a sua chave. Gere a chave no Portal do lojista → Integração (ou peça ao seu gerente GetPrime). Guarde-a com segurança: ela é mostrada uma única vez.

O escopo é sempre a conta da chave — você só acessa os dados do próprio estabelecimento. Sem a chave, ou com chave inválida/revogada, a resposta é 401.

X-Api-Key: gpk_suachavesecreta

Base

Todas as rotas são relativas a:

https://app.getprime.com.br

Formato de saída: JSON (padrão) ou CSV acrescentando ?format=csv (separador ;, com BOM para Excel pt-BR).

Escopos (permissões por chave)

Cada chave pode ser limitada a um ou mais escopos. Uma chave sem escopos tem acesso total (todos os endpoints de leitura). Com escopos definidos, chamar um endpoint fora deles retorna 403.

conta saldo transacoes dispositivos

Limites (rate limit)

Para proteger a plataforma, cada chave pode fazer até 120 chamadas por minuto. Ao exceder, a resposta é 429 com o header Retry-After: 60 — aguarde e tente de novo.

Chaves também podem ter expiração: depois da data definida, deixam de funcionar (401).

Endpoints

Parâmetros de /v1/integracao/transacoes

Exemplos

cURL — saldo

curl -H "X-Api-Key: SUA_CHAVE" \
  https://app.getprime.com.br/v1/integracao/saldo

cURL — transações (CSV)

curl -H "X-Api-Key: SUA_CHAVE" \
  "https://app.getprime.com.br/v1/integracao/transacoes?dataInicial=2026-10-01&dataFinal=2026-10-31&somentePositivos=true&format=csv"

JavaScript (fetch)

const r = await fetch("https://app.getprime.com.br/v1/integracao/transacoes?dataInicial=2026-10-01&dataFinal=2026-10-31", {
  headers: { "X-Api-Key": process.env.GETPRIME_API_KEY }
});
const transacoes = await r.json();

Python (requests)

import requests
r = requests.get(
    "https://app.getprime.com.br/v1/integracao/transacoes",
    params={"dataInicial": "2026-10-01", "dataFinal": "2026-10-31", "somentePositivos": "true"},
    headers={"X-Api-Key": "SUA_CHAVE"},
)
r.raise_for_status()
transacoes = r.json()

Resposta — transações (JSON)

Campos principais de cada transação:

Erros