Recurso

A v1 API é para desenvolvedores que querem executar a extração a partir do próprio código — um aplicativo, um script ou um pipeline de back-office — em vez de iniciar cada tarefa neste site. É uma interface diferente do Google Sheets Add-on, que atende ao caso de planilhas. Esta página cobre quem pode usar a API e onde sua documentação está; a referência da API em si está em outro lugar.

Para quem é a API

Use a API quando os dados extraídos precisarem chegar ao seu próprio sistema, em vez de uma planilha ou arquivo baixado. Ela permite que um programa envie documentos, inicie o processamento e colete os resultados sem que uma pessoa opere o aplicativo web para cada lote. Se você só precisa de linhas extraídas em uma planilha onde já trabalha, o Sheets Add-on é o caminho mais simples.

O que você precisa antes de começar

A API está disponível em qualquer plano pago, e não no plano Free. Uma conta Free é recusada: as chamadas retornam uma mensagem informando que um plano pago é necessário, mesmo com uma chave válida. Os planos que se qualificam são:

  • Basic, Pro ou Max — os planos pagos pessoais.
  • Growth, Scale ou Enterprise — os planos de equipe. Um membro da equipe é coberto pelo plano do proprietário da equipe, então um membro de uma equipe paga tem acesso à API por meio dele.

O acesso é verificado em cada chamada, e uma chave que não pertence a uma conta ativa é rejeitada.

A chave em si é uma credencial da sua conta, criada e substituída na página de perfil. Veja Gerenciamento de chaves de API para saber onde encontrá-la e como regenerá-la. Você não precisa de uma chave separada para a API — a mesma chave também conecta o Google Sheets Add-on.

Onde está a documentação completa

Tudo além do acesso está no site de documentação para desenvolvedores, não aqui. Ela cobre os formatos de requisição e resposta, os endpoints, os parâmetros que cada um aceita e exemplos práticos. Comece com:

Esta página deliberadamente não repete nenhum desse material.

📮 contact email: [email protected]