API de Integração

Skill para agentes de IA

Baixe a skill das APIs da Principia para o seu agente de IA (Claude, Cursor e outros) responder dúvidas e testar chamadas com base nesta documentação.

Se você usa um agente de IA para programar, baixe a skill das APIs da Principia. É um arquivo Markdown que ensina o agente a:

  • identificar se a dúvida é da API de Integração (IES) ou do PrincipiaPay (Checkout);
  • ler a página certa desta documentação antes de responder, em vez de inventar rotas ou campos;
  • evitar as pegadinhas mais comuns das duas APIs;
  • fazer chamadas de teste em homologação com a sua credencial, lida de variável de ambiente.

Instalar

Claude Code

Salve o arquivo em ~/.claude/skills/principia-apis/SKILL.md (para todos os seus projetos) ou em .claude/skills/principia-apis/SKILL.md dentro do repositório (para o time):

mkdir -p ~/.claude/skills/principia-apis
curl -sSL https://docs.ies.integracao.principia.net/skills/principia-apis/SKILL.md \
  -o ~/.claude/skills/principia-apis/SKILL.md

O Claude passa a usar a skill sozinho quando o assunto for integração com a Principia.

Outros agentes (Cursor, Codex, Copilot e similares)

Use o mesmo arquivo como regra ou instrução do projeto. Por exemplo, salve como .cursor/rules/principia-apis.md no Cursor, ou inclua o conteúdo no AGENTS.md do repositório.

Credenciais

A skill nunca pede a credencial no chat. Para o agente conseguir fazer chamadas de teste, defina a variável de ambiente no seu terminal:

export PRINCIPIA_IES_APIKEY="sua chave institucional"     # API de Integração (IES)
export PRINCIPIA_PAY_API_TOKEN="seu Api-Token"             # PrincipiaPay (Checkout)

Por padrão, a skill chama homologação e pede confirmação antes de qualquer chamada que altere dados.

Sempre atualizada

A skill aponta para esta documentação em vez de copiá-la. Quando uma página muda aqui, o agente já lê a versão nova. Baixe o arquivo de novo só quando quiser as regras mais recentes da própria skill.

Nesta página