Visual Studio Code + Raims
Configure o agente no VS Code com instruções e documentação para integrar a Raims.
Início rápido
Prepare o agente
Instale o VS Code e siga a configuração oficial do GitHub Copilot. Este guia usa o Copilot no editor; conclua o login com a conta GitHub apropriada.
Abra seu projeto
Abra a pasta da aplicação no VS Code e inicie uma conversa no Chat. Use o agente do Copilot com acesso ao projeto do seu backend.
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.
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 da aplicação. Esse é o arquivo de instruções gerais para o Copilot neste guia. Se escolher outro agente no VS Code, siga o formato de instruções documentado para ele.
# 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
Confira qual agente está ativo no Chat. As instruções deste guia usam Copilot; Claude e Codex têm formatos próprios descritos na documentação do VS Code.
Abra o guia relevante no navegador e forneça o trecho público como contexto. Peça ao agente para apontar o que falta antes de sugerir código.
Peça ao agente para revisar o guia de autenticação. O backend envia a chave Raims com Bearer; uma credencial do provedor de IA não a substitui.