Pular para o conteúdo
TurnitPass
DesenvolvedoresAPI v1Obter uma chave de API
Navegar na documentação

DesenvolvedoresAutenticação

Autenticar com chaves de API Bearer

As solicitações de desenvolvimento utilizam chaves de API geradas a partir do painel do TurnitPass.

REST API v1

Auth console

Mantenha as chaves de API fora do navegador.

As chamadas à API do TurnitPass usam uma chave Bearer do espaço de trabalho. A chave pertence ao código somente de servidor; o painel continua sendo o lugar para criar, rotacionar, revogar e inspecionar o uso.

Proteções da chave

Como manter o acesso seguro

Somente servidor

Envie as chaves a partir de rotas de backend, workers, jobs ou server actions seguras.

Exibida uma vez

Copie a chave gerada imediatamente e armazene-a no gerenciador de segredos.

Rotacione com segurança

Faça o deploy da chave de substituição antes de revogar a chave antiga de produção.

Escopo da conta

O uso é consolidado no saldo de palavras e nos controles de cobrança do espaço de trabalho.

Requisição Bearer

Contrato de cabeçalho

Privado por padrão
request
Bearer
fetch('https://turnitpass.com/api/v1/humanize', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer tp_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: draft, language: 'en' })
})
auth com falha
failed auth
401
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}
01Gerar no espaço de trabalho
02Guardar nos segredos
03Chamar do servidor
04Rotacionar ou revogar

Chaves de API

Envie `Authorization: Bearer tp_your_api_key` com cada solicitação. As chaves são exibidas uma única vez e podem ser revogadas no painel.

Authorization header
Bearer
Authorization: Bearer tp_live_your_api_key
Content-Type: application/json

POST /api/v1/humanize
As chaves aparecem uma vez na criação e podem ser revogadas no espaço de trabalho sem alterar a conta do Google.

Managing keys

01

Criar

Gere uma chave com nome no espaço de trabalho e copie-a imediatamente.

02

Revogar

Desative uma chave na hora. Chaves revogadas não podem autenticar novas requisições.

03

Limites de ritmo

Cada chave pode ser limitada de forma independente, enquanto o uso é consolidado na conta.

04

Cobrança

Todas as chaves compartilham o saldo de palavras e os limites de assinatura da conta.

De propriedade do espaço de trabalho

Key lifecycle

1

Criar uma chave com nome

Use um nome que descreva o ambiente ou a superfície, como Production backend, Staging worker ou Internal QA.

2

Copiá-la uma vez para um cofre de segredos

O TurnitPass exibe a chave só na criação. Armazene-a no provedor de deploy, no gerenciador de segredos de CI ou no arquivo .env local.

3

Acompanhar o uso com status e cobrança

Todas as chaves compartilham o saldo de palavras; os nomes ajudam a identificar qual integração está ativa.

4

Rotacionar antes de revogar

Crie uma chave de substituição, faça o deploy, confirme que o tráfego está saudável e então revogue a chave antiga no espaço de trabalho.

Environment setup

Armazene as chaves do TurnitPass como segredos somente de servidor. Os exemplos abaixo usam nomes genéricos para caber em Next.js, Workers, jobs de servidor ou qualquer runtime de backend.

.env
server only
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
Desenvolvimento local
.env.local ou gerenciador local de segredosUse uma chave fora de produção, com orçamento de palavras pequeno e nome claro.
Deploys preview
Chave de stagingSepare o tráfego preview para que jobs de teste não consumam uso de produção por acidente.
Produção
Segredo somente de backendLeia a chave só de código de servidor confiável. Nunca a passe ao navegador.

Security best practices

Somente no servidor
Nunca exponha chaves no código do navegadorUse as chaves a partir de serviços de backend, jobs ou rotas de servidor seguras.
Variáveis de ambiente
Use TURNITPASS_API_KEYEvite gravar chaves live no controle de versão ou em bundles de cliente.
Rotacionar chaves
Crie uma substituição antes de revogarUse chaves distintas para produção, staging e desenvolvimento.
Resposta a vazamento
Revogue imediatamenteCrie uma nova chave no espaço de trabalho se uma chave vazar.

Authentication errors

Cabeçalho ausente
Nenhum cabeçalho Authorization enviado
Formato inválido
O cabeçalho não começa com Bearer
Chave inválida
Chave não encontrada, revogada ou malformada
Muitas falhas
Tentativas de auth com falha repetidas podem ser limitadas
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

Em seguida, integre ao seu fluxo de trabalho.Continuar lendo