Ferramentas de desenvolvimento
GitHub no seu produto e nos seus agentes de IA, por uma API
O toolkit do GitHub cobre repositórios, issues, comentários e pull requests: listar e buscar, criar e atualizar issues, comentar, abrir um pull request e fazer o merge. O cliente conecta com uma API key ou OAuth, e seu produto ou agente de IA chama cada operação por um único endpoint do Connect, que guarda o log de auditoria de cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/github_create_issue/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"owner": "<owner>",
"repo": "<repo>",
"title": "<title>"
}
}Como funciona
Do cliente conectado à primeira chamada no GitHub.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do GitHub. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o GitHub.
Relatos de bug viram issues
Quando um usuário relata um problema no seu produto, crie uma issue no repositório certo com título, corpo, labels e responsáveis.
Ferramenta de release para times
Liste os pull requests abertos, leia mergeable e mergeable_state e faça o merge dos que estão prontos a partir do seu painel de release.
Agente de IA no fluxo de revisão
Deixe um agente buscar issues, ler um pull request, comentar nele e abrir um novo pull request a partir de uma branch.
Tools
12 tools do GitHub
- Listar repositóriosGETLista os repositórios que a conta alcança: os próprios, aqueles em que é colaboradora e os de suas organizações. Cada item tem owner.login e name, que são o owner e o repo que as outras ferramentas pedem. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Buscar issuesGETBusca issues e pull requests em todos os repositórios que a conta enxerga, com a sintaxe de busca do GitHub em q. Retorna total_count e items, até 1.000 resultados por busca; pagine com page e per_page. Cada item tem number, e repository_url termina com o owner e o repo do item.
- Listar issuesGETLista as issues de um repositório, da mais nova para a mais antiga. Pull requests também vêm na lista, marcados com a chave pull_request. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Obter issueGETRetorna uma issue, com title, body, state, labels, assignees e milestone. Uma issue movida para outro repositório responde 301 com o novo endereço.
- Criar issuePOSTCria uma issue em um repositório e a retorna, com seu number. Labels, assignees, milestone e type são descartados em silêncio quando a conta não tem acesso de push ao repositório. Notifica quem acompanha o repositório.
- Atualizar issuePATCHAltera uma issue e a retorna. Só os campos enviados mudam. Para fechá-la, envie state closed com um state_reason. Labels e assignees substituem os atuais, e uma lista vazia os limpa.
- Listar comentários da issueGETLista os comentários de uma issue ou de um pull request, do mais antigo para o mais novo. Os comentários de revisão no código de um pull request não estão incluídos. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Criar comentário na issuePOSTAdiciona um comentário a uma issue ou a um pull request e o retorna. Notifica os participantes.
- Listar pull requestsGETLista os pull requests de um repositório, do mais novo para o mais antigo. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Obter pull requestGETRetorna um pull request, com suas branches, head.sha, mergeable e mergeable_state, o número de commits e de arquivos alterados e se já foi mesclado. mergeable pode vir null enquanto o GitHub calcula: chame de novo após alguns segundos.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/github, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
Perguntas sobre o toolkit do GitHub
Preciso implementar a API do GitHub?
Não. O Connect já traz 12 tools do GitHub descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do GitHub?
Pelo modo que o toolkit aceita: Chave de API, OAuth com o app do seu produto. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
