Antes de começar O acesso à API está disponível apenas nos planos Enterprise (Empresarial). Você deve enviar uma solicitação de acesso e receber aprovação antes de gerar tokens de acesso. Se você não estiver em um plano Empresarial, entre em contato com o representante da sua conta Rayyan.
O Rayyan fornece uma API completa que permite interagir com seus dados de revisão programaticamente. Um SDK Python também está disponível para facilitar a integração. Use os links abaixo para começar:
- Formulário de solicitação de acesso à API — ryn.ai/APIRequestForm
- Documentação da API HTTP — ryn.ai/rayyan-api-docs
- SDK Python — ryn.ai/sdk
Como gerar seus tokens de acesso à API
Após a aprovação da sua solicitação de acesso:
- Faça login no Rayyan e clique no seu avatar no canto superior direito.
- No menu suspenso, selecione seu nome para abrir Detalhes da Conta.
- Gere seus tokens pessoais de acesso à API nesta página.
Para revogar ou gerar novos tokens manualmente a qualquer momento, acesse rayyan.ai/users/edit enquanto estiver logado.
Nota Os tokens de acesso expiram periodicamente por razões de segurança. Gere novos tokens em Detalhes da Conta quando necessário.
O acesso é regido por
- Plano — o tipo do seu plano determina quais recursos são acessíveis via API
- Função — as permissões da função atribuídas determinam quais chamadas de API podem ser feitas com sucesso
- Limitação de taxa — o acesso à API é limitado para evitar uso indevido e gerenciar requisições
- Conta — o acesso à API requer tokens de acesso pessoalmente atribuídos e gerados a partir da sua conta
Importante Rayyan reserva-se o direito de revogar o acesso à API em casos de uso indevido ou abuso.