Docs
Verificando conta Raims
Todos os agentes
GitHub

GitHub Copilot + Raims

Assistente no editor para planejar e escrever código de integração com a Raims.

Extensão
Documentação oficialDocumentação para agentesReferência da API

Início rápido

  1. Prepare o agente

    Siga a instalação oficial do GitHub Copilot para o seu editor e entre na conta GitHub com acesso ao Copilot. Neste guia, os exemplos de configuração usam o VS Code.

  2. Abra seu projeto

    Abra no VS Code a pasta da aplicação que vai integrar a Raims. Abra o Chat do Copilot e selecione o agente para trabalhar com o código do projeto.

  3. Adicione a documentação

    Peça ao agente para ler o índice da documentação Raims e abrir os guias relevantes. O llms-full.txt reúne o conteúdo completo. Comece por autenticação e cobranças.

  4. Experimente um prompt

    Leia https://docs.raims.com/llms.txt e os guias de autenticação e cobranças.
Analise o backend desta aplicação e proponha um plano para consultar uma
cobrança existente em Sandbox com GET /v1/charges/{id}. Prepare um exemplo
com a chave em configuração protegida do servidor. Não envie requisições
nem use credenciais reais. Apresente as fontes e os arquivos que pretende
alterar antes de editar.

Contexto do projeto

Crie ou complemente .github/copilot-instructions.md na raiz do seu repositório. Esse arquivo fornece as instruções gerais para as sessões do Copilot. Inclua o texto abaixo junto das convenções da sua aplicação.

Markdown
# Integração Raims

- Consulte https://docs.raims.com/llms.txt antes de escolher endpoints e campos.
- Use https://docs.raims.com/llms-full.txt para a documentação completa.
- URL base da API: https://api.raims.com.
- Nos exemplos de instalação de produtos Raims, obtenha a versão estável mais
  recente pelo gerenciador de pacotes (`latest` quando disponível).
- Prepare exemplos para Sandbox, com autenticação Bearer no backend.
- Mantenha a chave em configuração protegida do servidor. Não coloque segredos
  no código, em prompts, logs ou aplicações de navegador.
- Explique o plano e peça autorização antes de enviar requisições à API.

Verificar a configuração

Peça ao agente para indicar os guias lidos, a URL base e o ponto do backend em que a chave será carregada. Ele deve preparar o plano e o exemplo sem solicitar uma credencial real no chat.

Ler a documentação não autentica a aplicação. As requisições usam uma chave de API Raims da empresa e do ambiente desejados.

Problemas comuns

Fontes oficiais

Cursor + Raims

Editor com agente integrado para desenvolver sua integração Raims com contexto do projeto.

OpenCode + Raims

Agente de terminal com escolha de provedor de IA para implementar sua integração Raims.