O que nossa API de PDF expõe — Créditos e Limites
As páginas de API tendem a crescer mais rápido que as APIs. O nosso agora lista apenas as rotas que terminam sem navegador: conta, Redigir e Comparar. Isso é deliberado. Um endpoint que não consegue concluir seu fluxo de trabalho é pior do que nenhum endpoint.
O que está ao vivo hoje
- OBTER /v1/me — conta, plano e saldo de crédito em tempo real; 1 crédito por chamada.
- POST /v1/redact-pdf — encontre padrões, texto ou imagens e retorne um PDF editado com
apply=1. Livre. - POST /v1/compare-pdf — estatísticas, blocos alterados e principais diferenças entre dois PDFs. Livre.
Todos os três pegam uma chave ao portador de Minha Conta. Os resultados são JSON com um link para download que dura duas horas; os originais nunca são modificados no local.
O que não está na API
Quanto a API cobra hoje
Existem apenas três rotas: GET /v1/me custa 1 crédito, enquanto POST /v1/redact-pdf e POST /v1/compare-pdf custam 5 créditos cada. Não há cobrança de mesclagem ou API de OCR porque essas ferramentas não são terminais de API. As taxas ao vivo estão no Planos e preços página.
Por que o E-Signer não é uma rota
A assinatura é um fluxo de trabalho duplo do navegador: o remetente coloca campos na página e o destinatário abre um link e assina. Um cliente HTTP não pode ver o layout ou operar essa página, portanto, uma “API de assinatura eletrônica” seria interrompida antes que o trabalho fosse concluído. Os envelopes ficam no painel do E-Signer; a API não os cria nem os assina.
Chaves e retenção de arquivos
Trate uma chave de API como uma senha: uma chave por aplicativo, gire-a se ela tiver sido colada em um repositório público e nunca a coloque em JavaScript do navegador. Os arquivos enviados são cópias de trabalho temporárias com uma identificação indecifrável; eles não são um armazenamento de documentos. Mantenha os originais em seu próprio armazenamento e trate a resposta da API como uma cópia derivada. O Página de segurança lista os controles e a janela de retenção.
O que medir antes de atualizar
Acompanhe três números por um mês: ligações bem-sucedidas, ligações malsucedidas e o saldo de crédito no final. Redigir e Comparar são pagos (5 créditos cada), portanto, um mês movimentado fica visível no saldo; as chamadas de conta custam 1. Se novas tentativas ou picos no mês de pico consumirem créditos, um plano maior será mais barato do que um lote com falha. Como os créditos não utilizados são acumulados, um mês tranquilo não é desperdiçado.
O E-Signer é apenas para navegador. Alguém tem que colocar os campos de assinatura do destinatário visualmente, e o destinatário tem que abrir uma página de assinatura e assiná-la. Um cliente HTTP não pode fazer nenhuma das duas coisas, portanto não há rota de API para criar, assinar, listar ou pesquisar envelopes. O painel do E-Signer continua sendo o lugar certo para esse trabalho.
O mesmo teste remove mesclagem, compactação, conversão e editor da API por enquanto: seu fluxo de trabalho útil é interativo e com muitos arquivos. Eles permanecem gratuitos no navegador, em vez de serem anunciados como terminais parcialmente funcionais.
O que um crédito compra
Os créditos são o saldo pré-pago vinculado a uma conta comercial. Hoje as únicas rotas de API pagas são GET /v1/me com 1 crédito e Redigir e comparar com 5 créditos cada. Os planos ainda incluem uma concessão de crédito mensal e os créditos não utilizados são acumulados em vez de expirarem. Listamos taxas de API em tempo real no Planos e preços página e não publica preços por ferramenta para rotas que não existem.
Chaves, limites e segurança
As chaves de API são mostradas uma vez e armazenadas apenas como um hash. Uma chave revogada para de funcionar imediatamente. Resposta dos limites de taxa por chave e por IP 429 com Retry-After, os uploads são limitados por tamanho e contagem de páginas, e uma conta banida ou sem direito não pode usar uma chave ativa. O Página da API documenta as três rotas e seus campos de solicitação.
Primeiros passos
Crie uma conta, ative um plano Comercial se precisar de chaves API, depois crie a chave em Minha Conta e ligue GET /v1/me primeiro. Se uma ferramenta de navegador puder fazer o trabalho, use a ferramenta de navegador – ela permanece gratuita.