Documentação da API para geração de assinaturas

⚡ Início rápido

Três passos do registo à sua primeira assinatura.

🔗 URL base

Todas as respostas são JSON. Em caso de sucesso: { "success": true, "data": {…}, "meta": {…} }; em caso de erro: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Autenticação

Cada pedido precisa de um token Bearer no cabeçalho Authorization. Crie e faça a gestão das chaves na página de API da sua conta — a chave completa é mostrada apenas uma vez.

curl https://onlinesignatures.net/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_token"

🎨 Formatos de saída

Por defeito, a assinatura é devolvida como PNG transparente. Adicione o parâmetro format para obter outro formato — não consome quota adicional.

Chaves = quantas chaves de API pode criar neste plano. Pedidos / mês é a quota principal; pedidos / minuto é o limite contra picos.

🔍 Qualidade da imagem

Por padrão, a assinatura é devolvida em qualidade padrão (1×). Adicione o parâmetro quality para obter uma imagem maior e mais nítida: 2× tem o dobro de pixels e 4× o quádruplo. Não consome cota adicional.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"png",
      "quality":4}'

A mesma assinatura em outra qualidade

Para obter exatamente a mesma assinatura em outra qualidade, guarde o hash da resposta e solicite-a novamente com POST /api/v1/signatures/replay. Cada chamada conta como uma requisição.

curl -X POST https://onlinesignatures.net/api/v1/signatures/replay \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"hash":"eyJpdiI6...",
      "format":"png",
      "quality":4}'

Gere uma assinatura nova a partir de um nome e sobrenome.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator"}'

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"pdf"}'

Parâmetros

{
  "success": true,
  "data": {
    "id": 1842,
    "hash": "eyJpdiI6...",
    "format": "pdf",
    "mime": "application/pdf",
    "signature": "data:application/pdf;
       base64,JVBER..."
  },
  "meta": { "quota": { "remaining":179 } }
}

{
  "success": false,
  "error": {
    "code": "format_not_allowed",
    "message": "The pdf format is
      not available on
      your plan."
  }
}

Gere novamente uma assinatura criada anteriormente pelo seu hash. Também pode definir o formato através de ?format=.

curl "https://onlinesignatures.net/api/v1/signatures/{hash}?format=svg" \
  -H "Authorization: Bearer sk_live_your_token"

Devolve o seu plano, os formatos disponíveis, o limite mensal, o que já usou e quando é reiniciado.

{
  "success": true,
  "data": {
    "plan": "Business",
    "formats": ["png", "svg", "jpg"],
    "rate_per_minute": 1000,
    "key": { "name": "Production", "masked": "sk_live_a1b2…8f9c" },
    "quota": { "limit": 500, "used": 321, "remaining": 179 }
  }
}

⏱️ Limites e quota

A quota mensal é o limite principal e depende do seu plano (ver Planos de API). Além disso, um limite por minuto (também por plano) protege contra picos. As respostas incluem os cabeçalhos X-Quota-Limit, X-Quota-Remaining e X-Quota-Reset para se autorregular. Mudar de formato não consome quota adicional: uma geração = um pedido.

⚠️ Códigos de erro