Seu ERP, conectado à sua base.
Convites, clientes e contratos com IDX, sempre isolados por Partner.
1. Crie uma chave
No painel Partner, abra sua empresa → Contratos / IDX → Integração API. Administradores podem gerar uma chave com validade de até 365 dias e escolher suas permissões. A chave completa é exibida uma única vez. Use-a somente no servidor do ERP.
Base: https://partner.guardasenha.com.br/api/v1/integrations/v1 Authorization: Bearer SUA_CHAVE_DO_PARTNER Content-Type: application/json
2. Crie o contrato e o convite
O IDX é o identificador real do contrato no seu sistema. É único dentro deste Partner. O CPF válido vincula o cliente; informe também o e-mail para enviar um convite. Repetir o mesmo IDX e CPF atualiza o contrato, sem duplicar.
POST /contracts
{
"idx": "ERP-12345",
"cpf": "CPF_VALIDO_DO_CLIENTE",
"email": "cliente@exemplo.com.br",
"monthly_amount_cents": 2500,
"status": "active"
}O preço é informado em centavos: 2500 representa R$ 25/mês. Zero indica benefício incluído. O GuardaSenha não cobra esse valor pelo Mercado Pago. Sem e-mail, a liberação do CPF aguarda a confirmação do vínculo no cadastro.
3. Consulte clientes e utilização
| Operação | Permissão | Resultado |
|---|---|---|
| GET /me | contracts:read | Identidade do Partner da chave |
| GET /contracts?offset=0&limit=100 | contracts:read | IDX, preço, contrato e uso da vaga |
| GET /clients?offset=0&limit=100 | clients:read | Clientes vinculados, CPF mascarado e IDX |
| POST ou PUT /contracts | contracts:write | Cria ou atualiza contrato e envia o primeiro convite quando aplicável |
| PATCH /contracts/ERP-12345 | contracts:write | Ativa ou inativa o contrato |
| GET /events?cursor=0 | events:read | Alterações de contrato e escolha de provedor |
Ativo e selecionado são coisas diferentes
contract_status: active significa que o provedor permite o benefício. selected: true significa que o cliente escolheu esse contrato e utiliza uma vaga. Somente a opção escolhida deve ser contabilizada no programa. Os outros vínculos continuam cadastrados, sem consumo de vaga.
Para a posição atual, consulte /contracts. Para acompanhar mudanças, percorra /events usando o cursor retornado, até has_more: false. Eventos são históricos; expiração de licença ou pacote deve ser conciliada com a posição atual dos contratos.
Inativar um acesso
PATCH /contracts/ERP-12345
{"status": "inactive"}Se estiver selecionado, o contrato deixa de consumir uma vaga e o cliente fica em modo consulta ao cofre pessoal. Itens e conta são preservados. Reativar com active torna a opção disponível; o cliente precisa selecioná-la novamente.
Limites e erros
Paginação de até 100 registros; limite de 6.000 chamadas por chave e 2.000 por IP em 15 minutos. Respostas usam error.code, error.message e request_id. 401 indica chave inválida; 403 indica permissão ausente; 404 indica contrato inexistente neste Partner; 409 indica conflito de IDX/CPF; 422 indica dados inválidos; 429 pede nova tentativa depois da janela de 15 minutos. Não repita automaticamente operações com dados diferentes.
O contrato de um Partner nunca pode ser consultado pela chave de outro. A API não retorna senhas, chaves de cofre ou conteúdo cifrado dos clientes. Revogue chaves que não forem mais utilizadas pelo painel.
Abrir meu painel →