Skip to main content

Esta versão do GitHub Enterprise Server foi descontinuada em 2024-09-25. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Sobre a API REST

Obtenha orientação sobre a documentação da API REST.

Você pode usar a API da GitHub para compilar scripts e aplicativos que automatizam processos, promovem integração com GitHub e estendem GitHub. Por exemplo, você pode usar a API para triar problemas, criar um painel de análise ou gerenciar versões.

Cada ponto de extremidade da API REST é documentado individualmente e os pontos de extremidade são categorizados pelo principal recurso que afetam. Por exemplo, você poderá encontrar pontos de extremidade relacionados a problemas em "Pontos de extremidade da API REST para issues".

Introdução à API REST

Se você estiver começando a usar as APIs REST, talvez seja útil consultar o Guia de início rápido ou de introdução para conhecer os elementos básicos. Para obter mais informações, consulte:

Se você já estiver familiarizado com as APIs REST, mas estiver começando a usar a API REST da GitHub, talvez seja útil consultar a documentação de autenticação. Para obter mais informações, consulte:

Se você estiver criando scripts ou aplicativos que usem a API REST, talvez alguns dos guias a seguir sejam úteis. Para obter exemplos de scripts com a API REST, consulte:

Para obter uma lista de bibliotecas para facilitar a criação de scripts com a API REST, consulte "Bibliotecas para a API REST".

Se você estiver criando scripts ou aplicativos que usem a API REST, talvez também tenha interesse em usar webhooks para receber notificações sobre eventos ou um GitHub App para acessar recursos em nome de um usuário ou em uma organização. Para obter mais informações, confira "Sobre webhooks" e "Decidir quando compilar o Aplicativo GitHub."

Leitura adicional