MPS API do MPS PDF
Ligue o seu sistema jurídico, contábil ou de gestão ao MPS PDF: crie envelopes de assinatura, acompanhe quem já assinou, baixe o PDF final, junte PDFs e preencha modelos, tudo por HTTPS com uma chave.
A API faz parte do plano Escritório. Cada chave libera 100 chamadas por dia, renovadas à meia-noite (horário de Brasília). Endereço base: https://mpspdf.com.br.
1. A chave
Gere a chave padrão em mpspdf.com.br/envelopes, no painel da conta, "Chave da API". Ela fica no painel da sua conta (botão "Mostrar"); guarde-a também no cofre de segredos do seu sistema e nunca a coloque em código público. Envie-a em todo pedido no cabeçalho X-API-Key.
curl -H "X-API-Key: SUA_CHAVE" https://mpspdf.com.br/api/v1/envelopes/env_0123456789ab| Resposta | Quando |
|---|---|
401 | Sem chave ou chave inválida. |
403 | A conta não tem a API no plano. |
429 | A chave já usou as 100 chamadas de hoje. |
400 | Pedido incompleto; o campo detail explica em português. |
2. Envelopes de assinatura
POST /api/v1/envelopes
Cria o envelope e envia o convite por e-mail a cada signatário. Corpo multipart/form-data:
| Campo | Tipo | Descrição |
|---|---|---|
file | arquivo | O PDF a assinar. |
title | texto | Nome do documento, que aparece para quem assina. |
signers_json | JSON | Lista de pessoas: name, email e, opcionais, phone, doc_id (CPF ou OAB) e role (signer, witness, approver ou observer). |
workflow_type | texto | parallel (todos ao mesmo tempo, padrão) ou sequential (na ordem da lista). |
curl -X POST https://mpspdf.com.br/api/v1/envelopes \
-H "X-API-Key: SUA_CHAVE" \
-F "file=@contrato.pdf" \
-F "title=Contrato de honorários" \
-F 'signers_json=[{"name":"Maria Souza","email":"maria@exemplo.com.br","doc_id":"123.456.789-00"}]' \
-F "workflow_type=parallel"A resposta traz o id do envelope (env_...), a situação e os signatários.
GET /api/v1/envelopes/{id}
Situação do envelope e de cada signatário (pendente, visualizado, assinado), com a trilha de eventos.
GET /api/v1/envelopes/{id}/download
O PDF final, com a folha de assinaturas e o QR de conferência. Disponível quando todos assinaram.
3. Operações de PDF
POST /api/v1/merge
Junta dois ou mais PDFs (campo files repetido) na ordem enviada, com um marcador por arquivo. Responde o PDF.
curl -X POST https://mpspdf.com.br/api/v1/merge \
-H "X-API-Key: SUA_CHAVE" \
-F "files=@peticao.pdf" -F "files=@procuracao.pdf" -o juntado.pdfPOST /api/v1/dados
Preenche um modelo: troca as marcações {{campo}} do PDF pelos valores de campos_json. Responde o PDF preenchido.
curl -X POST https://mpspdf.com.br/api/v1/dados \
-H "X-API-Key: SUA_CHAVE" \
-F "file=@modelo-procuracao.pdf" \
-F 'campos_json={"nome":"Maria Souza","cpf":"123.456.789-00"}' -o procuracao.pdf4. Aviso quando todos assinam
No painel da conta, em "Aviso para outro sistema", informe o endereço HTTPS do seu sistema. Quando todos assinam um envelope, o MPS PDF envia um POST com JSON. Se o seu sistema não responder, o envio se repete sozinho.
{"event": "envelope_completed", "envelope_id": "env_0123456789ab", "user_id": 42}Ao receber, consulte GET /api/v1/envelopes/{id} e baixe o PDF final.
Perguntas frequentes
Os documentos ficam guardados?
Os envelopes ficam na sua conta enquanto ela existir; junções e preenchimentos são processados e descartados. Veja onde ficam seus arquivos.
Preciso de mais que 100 chamadas por dia?
Fale com a MPS pelo contato@mpspdf.com.br para uma chave com teto maior.
A chave vazou. E agora?
Escreva na hora para contato@mpspdf.com.br: a MPS desliga a chave e libera uma nova.