Instalação e configuração

Instale o SDK do Publiq para Node.js, Python ou PHP, crie sua API key e valide a configuração com uma primeira chamada.

1. Instale o SDK

Os SDKs oficiais são o jeito recomendado de usar o Publiq — trazem tipos, retries automáticos e idempotência. Instale conforme sua linguagem:

npm install publiq

pnpm add publiq

yarn add publiq

pip install publiq

composer require publiq/publiq

2. Crie sua API key

No painel, vá em Configurações → API Keys e gere uma chave. Chaves têm escopo (full ou read-only) — use full para enviar. Guarde-a com segurança: ela é mostrada uma única vez.

3. Configure o ambiente

O SDK lê a variável PUBLIQ_API_KEY automaticamente. Defina-a no ambiente do servidor (.env, secrets do provedor, etc.):

PUBLIQ_API_KEY=pk_live_xxxxxxxxxxxxxxxx

Nunca exponha a API key no frontend (React, mobile, apps client-side). Chame o Publiq sempre a partir do servidor — veja os guias de Next.js, NestJS e Express.

4. Valide a configuração

Faça uma chamada de leitura para confirmar que a chave funciona (não envia nada):

import { Publiq } from 'publiq';

const publiq = new Publiq(process.env.PUBLIQ_API_KEY);
const { data } = await publiq.templates.list();
console.log('OK —', data.length, 'templates');

curl https://api.publiq.digital/v1/templates \
  -H "Authorization: Bearer $PUBLIQ_API_KEY"

O SDK Node é escrito em TypeScript e traz os tipos de todos os parâmetros e respostas — o autocomplete do editor guia você. Próximo passo: Quickstart.