Ferramentas para desenvolvedores
CHAMPREP As ferramentas de desenvolvedor oferecem uma maneira consistente de automatizar fluxos de trabalho compatíveis sem chamar back-ends de serviços individuais. Autenticação, acesso a serviços, escopos, controles de uso e contexto de auditoria são aplicados noAPI Gateway.
Escolha um caminho de integração
Seção intitulada “Escolha um caminho de integração”| Caminho | Ideal para | Comece aqui |
|---|---|---|
| API Gateway | Integrações diretas via HTTPS e aplicativos personalizados | API Gateway Visão geral |
| CHAMPREP CLI | Trabalho no terminal interativo, scripts e tarefas de CI | CLI Visão geral |
| Webhooks | Integrações orientadas a eventos que não devem realizar polling | Webhooks |
| Oficial SDKs | Clientes tipados para serviços e estruturas compatíveis | CHAMPREP SDKs |
| SCIM 2.0 | Provisionamento por provedor de identidade corporativo | SCIM provisionamento |
Todos os comandosCLI em rede e SDKsolicitações oficiais utilizam o Gateway. Evite criar integrações com base em URLs voltadas para o navegador ou privadas do back-end de um serviço; essas rotas não constituem um contrato público estável.
Introdução rápida
Seção intitulada “Introdução rápida”- Faça login no eCHAMPREP abra API Chaves.
- Crie uma chave contendo apenas os escopos exigidos pela sua integração.
- Armazene a chave em um gerenciador de segredos ou no chaveiro do sistema operacional.
- Envie uma solicitação ao Gateway de produção:
export CHAMPREP_TOKEN='replace-with-your-api-key'
curl --fail-with-body \ --header "Authorization: Bearer $CHAMPREP_TOKEN" \ https://api.champrep.com/v1/auth/whoamiA resposta identifica a conta ativa e o contexto das credenciais. Continue com autenticação e chavesAPI antes de adicionar escopos de serviço.
Os controles da plataforma continuam em vigor
Seção intitulada “Os controles da plataforma continuam em vigor”Uma chave válida não contorna os controles do produto que se aplicam no CHAMPREP. Uma solicitação só pode prosseguir quando todas as condições a seguir forem atendidas:
- API Gateway O acesso está habilitado para o plano e o perfil ativos.
- O serviço de destino está disponível para o plano e a organização ativos.
- A chave contém o escopo exigido pelo método e pelo recurso.
- Os controles de uso em tempo real por minuto, diários e específicos do serviço permitem isso.
- A função ativa está autorizada a realizar a operação no serviço de destino.
É por isso que uma chaveAPI deve ser tratada como uma interface adicional para a mesma conta, e não como uma forma de contornar políticas de conta, plano, função ou organização.