Documentação da API REST do GitHub
Crie integrações, recupere dados e automatize seus fluxos de trabalho com a API REST do GitHub.
Comece por aqui
Exibir tudoSobre a API REST
Obtenha orientação sobre a documentação da API REST.
Introdução à API REST
Aprenda a usar a API REST do GitHub.
Autenticação na API REST
Você pode se autenticar na API REST para acessar mais pontos de extremidade e ter um limite de taxa mais alto.
Práticas recomendadas para usar a API REST
Siga estas melhores práticas quando usar a API do GitHub.
Popular
Limites de taxa para a API REST
Saiba mais sobre os limites de taxa da API REST, como não ultrapassá-los e o que fazer se você excedê-los.
Solucionar problemas do API REST
Saiba como diagnosticar e resolver problemas comuns de API REST.
Scripts com a API REST e o JavaScript
Escreva um script usando o SDK do Octokit.js para interagir com a API REST.
Manter suas credenciais de API seguras
Siga estas práticas recomendadas para manter as suas credenciais de API e tokens seguros.
Entregar implantações
Ao usar a API RESt de implantações, você pode criar ferramentas personalizadas que interagem com seu servidor e um aplicativo de terceiros.
Como usar a API REST para interagir com verificações
Use a API REST para criar GitHub Apps que executam verificações avançadas em alterações de código em um repositório. Você pode criar os aplicativos que realizam integração contínua, linting ou serviços de varredura de código e fornecem feedback detalhado sobre commits.
Como usar paginação na API REST
Saiba como navegar pelas respostas paginadas da API REST.
Usando a API REST
- Introdução à API REST
- Limites de taxa para a API REST
- Como usar paginação na API REST
- Bibliotecas para a API REST
- Práticas recomendadas para usar a API REST
- Solucionar problemas do API REST
- Fusos horários e a API REST
- Usando CORS e JSONP para fazer solicitações de origem cruzada
- Tipos de eventos de problemas
- Tipos de eventos do GitHub
Autenticação na API REST
- Autenticação na API REST
- Manter suas credenciais de API seguras
- Pontos de extremidade disponíveis para tokens de acesso de instalação do aplicativo GitHub
- Endpoints disponíveis para tokens de acesso do usuário do aplicativo GitHub
- Pontos de extremidade disponíveis para tokens de acesso pessoal refinados
- Permissões necessárias para os aplicativos GitHub
- Permissões necessárias para tokens de acesso pessoal refinados
Guides
- Scripts com a API REST e o JavaScript
- Scripts com a API REST e o Ruby
- Descobrir recursos para um usuário
- Entregar implantações
- Representar dados como gráficos
- Trabalhar com comentários
- Criar um servidor de CI
- Como usar a API REST para interagir com seu banco de dados Git
- Como usar a API REST para interagir com verificações
- Criptografando segredos para a API REST
Pontos de extremidade da API REST do GitHub Actions
- Pontos de extremidade de API REST para artefatos do GitHub Actions
- Pontos de extremidade da API REST para o cache do GitHub Actions
- Executores hospedados no GitHub
- Pontos de extremidade da API REST para OIDC do GitHub Actions
- Pontos de extremidade da API REST para permissões do GitHub Actions
- Pontos de extremidade da API REST para segredos do GitHub Actions
- Pontos de extremidade da API REST para grupos de executores auto-hospedados
- Pontos de extremidade da API REST para executores auto-hospedados
- Pontos de extremidade da API REST para variáveis do GitHub Actions
- Pontos de extremidade da API REST para trabalhos do fluxo de trabalho
- Pontos de extremidade da API REST para execuções de fluxo de trabalho
- Pontos de extremidade da API REST para fluxos de trabalho
Pontos de extremidade da API REST para o Codespaces
- Pontos de extremidade da API REST para o Codespaces
- Pontos de extremidade da API REST para organizações do Codespaces
- Pontos de extremidade da API REST para segredos de organizações do Codespaces
- Pontos de extremidade da API REST para máquinas Codespaces
- Pontos de extremidade da API REST para segredos de repositório do Codespaces
- Pontos de extremidade da API REST para segredos de usuário do Codespaces
Pontos de extremidade da API REST para implantações
- Pontos de extremidade da API REST para políticas de branch de implantação
- Pontos de extremidade da API REST para implantações
- Pontos de extremidade da API REST para ambientes de implantação
- Pontos de extremidade da API REST para regras de proteção
- Pontos de extremidade da API REST para status de implantação
Pontos de extremidade da API REST para issues
- Pontos de extremidade da API REST para destinatários de problemas
- Pontos de extremidade da API REST para comentários de issues
- Pontos de extremidade da API REST para eventos de issues
- Pontos de extremidade da API REST para issues
- Pontos de extremidade da API REST para dependências de issue
- Pontos de extremidade da API REST para rótulos
- Pontos de extremidade da API REST para marcos
- Pontos de extremidade da API REST para subproblemas
- Pontos de extremidade da API REST para eventos de linha do tempo
Pontos de extremidade de API REST para organizações
- Pontos de extremidade da API REST para Insights de API
- Pontos de extremidade de API REST para atestados de artefatos
- Pontos de extremidade de API REST para bloquear usuários
- Pontos de extremidade de API REST para propriedades personalizadas
- Pontos de extremidade da API REST para tipos de issue
- Pontos de extremidade de API REST para membros da organização
- Pontos de extremidade da API REST para configurações de rede
- Pontos de extremidade de API REST para funções da organização
- Pontos de extremidade de API REST para organizações
- Pontos de extremidade de API REST para colaboradores externos
- Pontos de extremidade de API REST para tokens de acesso pessoal
- Pontos de extremidade da API REST para conjuntos de regras
- Pontos de extremidade da API REST para regras
- Pontos de extremidade de API REST para gerentes de segurança
- Pontos de extremidade de API REST para webhooks da organização
Pontos de extremidade da API REST para repositórios
- Pontos de extremidade de API REST para autolinks de repositório
- Pontos de extremidade da API REST para conteúdos de repositório
- Pontos de extremidade de API REST para propriedades personalizadas
- Pontos de extremidade de API REST para forks
- Pontos de extremidade da API REST para repositórios
- Pontos de extremidade da API REST para conjuntos de regras
- Pontos de extremidade da API REST para regras
- Pontos de extremidade da API REST para tags de repositório
- Pontos de extremidade da API REST para webhooks de repositório
Pontos de extremidade de API REST para usuários
- Pontos de extremidade de API REST para atestados de artefatos
- Pontos de extremidade de API REST para bloquear usuários
- Pontos de extremidade da API REST para emails
- Pontos de extremidade de API REST para seguidores
- Pontos de extremidade da API REST para chaves GPG
- Pontos de extremidade da API REST para chave SSH do Git
- Pontos de extremidade de API REST para contas de rede social
- Pontos de extremidade de API REST para chaves de assinatura SSH
- Pontos de extremidade de API REST para usuários