AjudaManual da API Pública

API Pública do Scrivox

Um guia completo — e em português de verdade — sobre o que é a API, para quem serve, como usar e o que fazer com ela. Sem assumir que você é programador.

1

O que é a API pública?

Imagine que o Scrivox é uma biblioteca onde você guarda e cria artigos. Normalmente você acessa essa biblioteca pelo site — clicando, navegando, lendo. A API pública é uma "entrada de serviço" dessa mesma biblioteca: uma forma de outros programas e sistemas acessarem seus artigos automaticamente, sem precisar de alguém clicando na tela.

A sigla API vem do inglês Application Programming Interface, mas o que importa é o que ela faz: permite que seu site, suas automações ou qualquer outro sistema "converse" com o Scrivox e busque seus artigos de forma automática.

Exemplo concreto:

Você cria um artigo no Scrivox. Seu site WordPress puxa esse artigo automaticamente e o publica em uma seção "Últimos artigos" — sem você copiar e colar nada.
Toda vez que você publica um artigo LinkedIn no Scrivox, o Zapier detecta e envia um aviso para o seu time no Slack automaticamente.
Um desenvolvedor cria um painel personalizado com métricas dos seus artigos, puxando os dados do Scrivox via API.
2

Para quem é?

✅ Você precisa da API se quer:

  • • Que seu site mostre automaticamente os artigos que você cria
  • • Usar Zapier ou Make para automatizar ações
  • • Integrar o Scrivox com seu CRM ou sistema de gestão
  • • Ter um painel personalizado com seus dados (feito por um dev)

🚫 Você NÃO precisa da API se:

  • • Usa o Scrivox só pelo navegador normalmente
  • • Copia e cola os artigos manualmente
  • • Não faz integrações com outros sistemas
💡

Plano necessário

A API pública está disponível somente no plano Pro. No plano Free, as chamadas retornam erro 403.

3

Chaves de API — o que são e como criar

A chave de API é como um crachá de acesso exclusivo para sistemas externos. Em vez de dar seu login e senha do Scrivox para outro programa, você cria uma chave específica para ele. Se precisar cancelar o acesso, é só apagar a chave — sem precisar trocar sua senha principal.

Você pode ter até 5 chaves — uma para cada integração:

scrivox_sk_abc1...Meu site WordPress (pega artigos para publicar)
scrivox_sk_def2...Zapier (automações)
scrivox_sk_ghi3...Dashboard da equipe (painel interno)

Ter chaves separadas é importante: se o Zapier for comprometido, você revoga só a chave do Zapier — o site e o dashboard continuam funcionando.

Como criar uma chave:

  1. 1No Scrivox, clique em Configurações no menu lateral
  2. 2Role até a seção Chaves de API
  3. 3No campo Nome da chave, escreva de onde vem (ex: "Meu site WordPress", "Zapier")
  4. 4Clique em + Criar
  5. 5A chave aparece uma única vez — copie agora e guarde em local seguro (gerenciador de senhas). Depois disso, ela nunca mais será exibida completa.
⚠️

A chave tem o formato scrivox_sk_ seguido de letras e números. Nunca compartilhe sua chave em mensagens, e-mails ou código publicado — ela dá acesso total aos seus artigos.

4

Como autenticar — o cabeçalho Authorization

Todo sistema que aceita API precisa saber "quem está fazendo essa pergunta". Isso é feito através de um cabeçalho (header) — um dado extra enviado junto com a requisição, invisível para o usuário final.

O Scrivox usa o padrão chamado Bearer Token — um dos mais comuns na internet. Funciona assim:

Formato do cabeçalho de autenticação
Authorization: Bearer scrivox_sk_sua_chave_aqui

Entendendo cada parte:

AuthorizationNome do cabeçalho. Sempre assim, não muda.
BearerTipo de autenticação. Sempre assim, não muda. Note o espaço após "Bearer".
scrivox_sk_...Sua chave de API. Troque pelo valor real copiado em Configurações.

Se esse cabeçalho não for enviado — ou se a chave estiver errada — o Scrivox retorna o erro 401 Unauthorized. É como tentar entrar em um lugar sem o crachá.

🔒

Onde configurar isso varia por ferramenta

No Zapier: aba "Headers" ao configurar o módulo HTTP/Webhook

No Make: campo "Headers" ao configurar o módulo HTTP

No seu site: dentro do código, na função fetch() ou axios

No Insomnia/Postman: aba "Auth" → tipo Bearer Token

5

Fazendo sua primeira chamada

"Fazer uma chamada" significa enviar uma pergunta para o Scrivox via internet e receber uma resposta com seus dados. Veja como fazer isso nas ferramentas mais comuns:

No Zapier (sem programação):

  1. 1Crie um novo Zap e adicione o trigger que desejar (ex: agendado diariamente)
  2. 2Adicione uma ação: Webhooks by ZapierGET
  3. 3URL: https://scrivox.com.br/api/v1/articles
  4. 4Em Headers, adicione: Key: Authorization / Value: Bearer scrivox_sk_sua_chave
  5. 5Clique em "Test" — seus artigos aparecerão como dados para usar nas próximas etapas do Zap

No terminal / linha de comando (para testar rapidamente):

curl
curl https://scrivox.com.br/api/v1/articles \
  -H "Authorization: Bearer scrivox_sk_sua_chave_aqui"

Em JavaScript (para o seu site ou app):

JavaScript / TypeScript
const resposta = await fetch('https://scrivox.com.br/api/v1/articles', {
  headers: {
    'Authorization': 'Bearer scrivox_sk_sua_chave_aqui'
  }
})

const dados = await resposta.json()
console.log(dados.articles)  // lista de artigos
console.log(dados.total)     // total de artigos existentes
6

Endpoint de artigos — o que dá para buscar

Um endpoint é um "ponto de acesso" da API — um endereço específico para cada tipo de dado. O Scrivox tem o endpoint de artigos:

Endpoint principal
GET https://scrivox.com.br/api/v1/articles

GET significa "quero buscar" — não criar, não apagar, só ler. Pense como fazer uma pergunta: "me dê meus artigos".

Filtrando os resultados:

Você pode refinar o que quer receber adicionando parâmetros no final da URL, após o ?. É como adicionar filtros em uma busca.

ParâmetroO que fazExemplo
channelFiltra por canal de publicação?channel=linkedin
statusFiltra por estado do artigo?status=published
limitQuantidade de artigos retornados (padrão: 20, máximo: 100)?limit=5
offsetQuantos artigos pular — usado para paginação?offset=20

Valores possíveis para cada filtro:

channel

linkedininstagramnewsletterarticletiktokthread

status

published(padrão)
draft
scheduled
all(todos)

Exemplos de URLs completas:

Exemplos práticos
# Só artigos do LinkedIn
GET /api/v1/articles?channel=linkedin

# Os 5 artigos mais recentes publicados
GET /api/v1/articles?limit=5&status=published

# Todos os rascunhos
GET /api/v1/articles?status=draft

# Artigos de newsletter, 10 por vez
GET /api/v1/articles?channel=newsletter&limit=10

# Todos os artigos (qualquer canal ou status)
GET /api/v1/articles?status=all
7

Entendendo a resposta — o que você recebe

A resposta vem no formato JSON — um formato de texto estruturado que computadores entendem. Parece intimidador, mas é simplesmente uma lista organizada de dados. Veja um exemplo real:

Exemplo de resposta da API
{
  "articles": [
    {
      "id":           "abc-123-def",
      "title":        "Como a IA está mudando o marketing",
      "channel":      "linkedin",
      "status":       "published",
      "language":     "pt",
      "content":      "Texto completo do artigo aqui...",
      "created_at":   "2026-05-29T10:00:00Z",
      "published_at": "2026-05-29T14:00:00Z"
    },
    {
      "id":           "xyz-456-ghi",
      "title":        "5 tendências de conteúdo para 2027",
      "channel":      "newsletter",
      "status":       "draft",
      "language":     "pt",
      "content":      "Rascunho do texto...",
      "created_at":   "2026-05-28T09:00:00Z",
      "published_at": null
    }
  ],
  "total":  42,
  "limit":  20,
  "offset": 0
}

O que cada campo significa:

idIdentificador único do artigo — como um CPF. Útil para referenciar um artigo específico.
titleTítulo do artigo gerado.
channelCanal para o qual foi gerado (linkedin, instagram, newsletter, article, tiktok, thread).
statusEstado atual: published = publicado, draft = rascunho, scheduled = agendado.
languageIdioma do artigo (pt = português, en = inglês).
contentO texto completo do artigo — o conteúdo gerado pelo Scrivox.
created_atData e hora em que o artigo foi criado no Scrivox (formato ISO 8601, horário UTC).
published_atData e hora em que foi marcado como publicado. Será null se ainda for rascunho.
totalTotal de artigos que existem na sua conta (pode ser mais que os retornados nessa chamada).
limitQuantos artigos foram retornados nessa chamada.
offsetA partir de qual posição começou a contar (usado para paginação).
8

Paginação — como buscar muitos artigos

Se você tem 100 artigos, a API não retorna todos de uma vez. Ela retorna em "páginas" para não sobrecarregar. O padrão é 20 artigos por chamada.

Analogia:

É como folhear um livro de 100 páginas. Você não lê tudo de uma vez — vai de 20 em 20. O parâmetro limit define quantas "páginas" você quer de uma vez, e offset define onde você está no livro.

Percorrendo 100 artigos de 20 em 20
# Chamada 1 — artigos 1 a 20
GET /api/v1/articles?limit=20&offset=0

# Chamada 2 — artigos 21 a 40
GET /api/v1/articles?limit=20&offset=20

# Chamada 3 — artigos 41 a 60
GET /api/v1/articles?limit=20&offset=40

# Chamada 4 — artigos 61 a 80
GET /api/v1/articles?limit=20&offset=60

# Chamada 5 — artigos 81 a 100
GET /api/v1/articles?limit=20&offset=80

Use o campo total da resposta para saber quantas chamadas você precisa fazer:

Se total = 42 e limit = 20:

  • • Chamada com offset=0 → retorna 20 artigos
  • • Chamada com offset=20 → retorna 20 artigos
  • • Chamada com offset=40 → retorna 2 artigos (os últimos)
  • • Total: 3 chamadas para buscar tudo

Fórmula: número de chamadas = Math.ceil(total / limit)

9

Revogar uma chave — quando e como

Revogar significa cancelar o acesso de uma chave — ela deixa de funcionar imediatamente. Qualquer sistema que usar a chave revogada receberá o erro 401 Unauthorized e não conseguirá mais acessar seus dados.

⚠️ Quando revogar:

  • • Você percebeu que alguém não autorizado teve acesso à chave
  • • Publicou a chave por engano em um lugar público (ex: código no GitHub)
  • • Parou de usar a integração e quer garantir que ninguém mais acesse
  • • Quer substituir por uma nova chave por precaução

🛠️ Como revogar:

  1. 1. Vá em Configurações → Chaves de API
  2. 2. Localize a chave pelo nome que você deu
  3. 3. Clique em Revogar
  4. 4. Confirme — a chave é invalidada instantaneamente
🔄

Chave revogada x nova chave

Revogar não apaga seus artigos — apenas cancela o acesso daquela chave específica. Você pode criar uma nova chave e atualizar a integração com o novo valor.

10

Erros comuns e como resolver

Quando algo dá errado, a API retorna um código de status HTTP — um número que indica o tipo do problema. Os mais comuns:

CódigoNomeO que significaComo resolver
401UnauthorizedChave ausente, incorreta ou revogadaVerifique se a chave está certa e se você incluiu Bearer antes dela
403ForbiddenRecurso não disponível no seu plano atualConfirme que sua conta é Pro em Configurações → Plano
404Not FoundEndpoint não existeVerifique se a URL está correta (ex: /api/v1/articles)
429Too Many RequestsMuitas chamadas em pouco tempoAguarde alguns segundos antes de tentar novamente
500Server ErrorErro interno no servidor do ScrivoxTente novamente em alguns minutos. Se persistir, contate o suporte.

O erro mais comum: 401

Quase sempre causado por um destes motivos:

  • Esqueceu de incluir o cabeçalho Authorization
  • Escreveu Bearer sem o espaço antes da chave
  • A chave foi revogada e precisa criar uma nova
  • Copiou a chave com espaço extra no começo ou no final
Exemplo de resposta de erro
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Ainda com dúvidas?

Nossa equipe responde em até 24h úteis.

Enviar mensagem