01
Registar uma app de integração
Cria o registo da app externa e confirma grant types e redirect URIs aprovados para o teu tenant.
[Percurso de integração externa revisto]
Guia de Integração
Usa este percurso para integrações externas aprovadas. A configuração pública começa com registo de apps, scopes aprovados, tokens, webhooks e transporte GraphQL. O acesso revisto é usado apenas quando o fluxo precisa de capacidades exclusivas para parceiros.
Fluxo de onboarding recomendado
Começa pelo contrato público e só escala para acesso revisto quando o caso de uso o exigir.
02
Rever scopes aprovados
Pede apenas os scopes aprovados pelo administrador do tenant. Não desenhes para scopes não publicados.
03
Escolher o fluxo de token
Usa authorization code quando há um utilizador no fluxo, ou service tokens para automação headless.
04
Validar tokens e configurar entregas
Valida JWT através de JWKS e configura webhooks ou transporte GraphQL com tenant scoping.
05
Pedir acesso revisto só quando necessário
Usa o processo de vendor request para APIs avançadas, bundles GraphQL curados, federação ou onboarding específico do ambiente.
Superfícies públicas de confiança
Estas superfícies públicas são o ponto de partida suportado para integradores externos.
Identidade e registo de apps
Registo de apps, descoberta de scopes, governação, emissão de service tokens e rotação de secrets.
Abrir referência APIOAuth e service tokens
Fluxos aprovados para acesso delegado por utilizador e automação machine-to-machine.
Abrir referência APIEntrega de eventos e webhooks
Gestão, testes e diagnóstico de webhooks de saída para integrações aprovadas.
Abrir referência APIContrato de transporte GraphQL
Transporte GraphQL com bearer auth e tenant scoping, sem dumps de schema ou inventários de operações.
Abrir referência APIExpectativas operacionais
Trata o contrato público como o único limite suportado para automação, a menos que tenhas acesso revisto.
Guarda client secrets e service tokens no teu próprio secret manager e roda-os de forma deliberada.
Desenha consumidores de webhook idempotentes e tolerantes a retries.
Assume que os tópicos legíveis por máquina e os payloads de exemplo permanecem em inglês canónico.
Exemplo de fluxo público
# Register an external integration app
curl -X POST https://auth.knogin.com/v1/platform/apps \
-H "Authorization: Bearer <admin-access-token>" \
-H "Content-Type: application/json" \
-d '{"name":"Case sync connector","grant_types":["client_credentials"],"requested_scopes":["webhooks:write"]}'
# Exchange client credentials for a bearer token
curl -X POST https://auth.knogin.com/v1/oauth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=<client-id>&client_secret=<client-secret>&scope=webhooks:write"
# Create an outbound webhook
curl -X POST https://auth.knogin.com/v1/webhooks \
-H "Authorization: Bearer <access-token>" \
-H "Content-Type: application/json" \
-d '{"url":"https://integrator.example/webhooks/argus","events":["case.updated"]}'O exemplo mantém-se dentro do contrato público revisto: registar, emitir um token e depois criar um webhook de saída.
Capacidades que ficam atrás de acesso revisto
Estes workflows existem, mas não são documentados como blueprint público.
APIs avançadas da plataforma
Workflows alargados de control plane e caminhos administrativos só para parceiros são partilhados apenas após revisão.
Bundles GraphQL curados
Bundles aprovados podem ser partilhados para programas específicos sem expor o schema completo.
Federação e revisão de ambiente
Federação enterprise, SAML, revisão de deployment soberano e onboarding específico do ambiente são tratados caso a caso.
Pedir acesso revisto
Usa este formulário quando precisas de um workflow revisto, coordenação de sandbox ou documentação específica de parceiro que não é publicada no site.
Pedido de Integração de Fornecedor
Fale-nos sobre as suas necessidades de integração e responderemos no prazo de 2 a 3 dias úteis.