API da SMARTFENSE

Ligue a SMARTFENSE a todo o seu ecossistema de segurança

Uma API REST documentada que lhe dá acesso programático aos resultados das suas campanhas, ao scoring de risco e à gestão de utilizadores. Automatize fluxos, leve as suas métricas para o seu BI e unifique a sensibilização com o resto do seu stack de segurança.

API da SMARTFENSE

RESTOAuth 2.0JSONHTTPS obrigatórioRespostas paginadasDatas em UTC (ISO 8601)

De uma plataforma que usa a uma plataforma sobre a qual constrói

As integrações nativas da SMARTFENSE (Microsoft Entra ID, Google, Slack, Teams, SAP SuccessFactors, Vanta, LDAP, SAML 2.0) resolvem os conectores mais comuns sem configuração. A API cobre o resto: qualquer fluxo, relatório ou automação própria da sua organização que não venha de origem, constrói-o com acesso direto aos dados.

Procura um conector pronto? Veja as integrações nativas →

Casos de uso

Leve as suas métricas para o seu BI

Alimente o PowerBI, o Looker ou o Tableau com os resultados das suas campanhas e o scoring de risco para construir os dashboards e relatórios executivos de que a sua organização precisa.

Possibilitado por: Resultados por tipo de campanha + Risk Scoring por utilizador, grupo e organização.

Enriqueça o seu SIEM ou o seu GRC

Incorpore o nível de risco dos seus utilizadores no seu stack de segurança para correlacionar o fator humano com o resto dos seus sinais e priorizar onde atuar.

Possibilitado por: Endpoints de Risk Scoring (utilizador / grupo / organização).

Automatize a gestão de utilizadores

Sincronize a sua plataforma de sensibilização com o seu IdP ou o seu sistema de Recursos Humanos: importe utilizadores e consulte a sua informação sem trabalho manual.

Possibilitado por: Importação de utilizadores (POST) e informação geral de utilizadores.

Centralize a sua evidência de conformidade

Exporte os registos de auditoria para as suas ferramentas de compliance e GRC para construir evidência consistente do seu programa de sensibilização.

Possibilitado por: Auditoria administrativa e de sistema + último acesso de administradores.

Unifique os resultados de todo o seu programa

Consolide num só lugar os resultados de phishing, ransomware, smishing, formações, exames, vídeos e mais, para medir o avanço real do seu programa.

Possibilitado por: Resultados de campanhas por cada tipo de ação.

Adicione a camada de engagement

Integre o progresso e as conquistas dos seus utilizadores nos seus próprios portais ou programas de reconhecimento interno.

Possibilitado por: Badges por utilizador.

Acesso às áreas-chave do seu programa de sensibilização

Através da API acede às grandes áreas de dados do seu programa:

  • Resultados de campanhas e ações de sensibilizaçãoO desempenho dos seus utilizadores nas diferentes ações que executa.
  • Scoring de RiscoO nível de risco ao nível de utilizador, grupo e organização.
  • Gestão de utilizadores e organizaçãoCriação de utilizadores e informação sobre a sua organização.
  • Auditoria e rastreabilidadeRegistos de atividade da plataforma.
  • ConteúdosInformação sobre os conteúdos disponíveis.

O catálogo completo e sempre atualizado de endpoints vive na documentação. Ver a referência da API →

Padrão, previsível e pronta para produção

Autenticação

A API usa OAuth 2.0. Suporta o fluxo Client Credentials para integrações servidor a servidor e o fluxo Authorization Code (com PKCE) quando a sua aplicação atua em nome de um utilizador. Cada aplicação é criada com os scopes de que necessita, e todas as chamadas viajam com um bearer token sobre HTTPS.

Formato de resposta

Todas as respostas são JSON. As datas são expressas em UTC com formato ISO 8601. As listagens são paginadas com uma estrutura consistente (count, next, previous, results), com até 100 registos por página.

Primeiros passos

1. Crie a sua aplicação e obtenha o seu client_id e client_secret. 2. Solicite um access token ao endpoint de OAuth. 3. Faça as suas chamadas incluindo o token no cabeçalho Authorization.

# Solicitar um access token (OAuth 2.0)
curl -X POST https://tu-instancia.smartfense.com/oauth/token/ \ -d grant_type=client_credentials \ -d client_id=TU_CLIENT_ID \ -d client_secret=TU_CLIENT_SECRET # Chamar a API com o token
curl https://tu-instancia.smartfense.com/api/... \ -H "Authorization: Bearer ACCESS_TOKEN"

A base URL é o domínio da sua instância. Consulte a documentação para os endpoints exatos. O seu client_secret é secreto: nunca o exponha em código de cliente nem no navegador.

Segurança e padrões

  • Autenticação OAuth 2.0 com dois fluxos (Client Credentials e Authorization Code com PKCE).
  • HTTPS obrigatório: qualquer chamada por HTTP simples é rejeitada.
  • Acesso por scopes: cada aplicação recebe apenas as permissões de que necessita.
  • Design REST padrão, compreensível por qualquer cliente HTTP, com códigos de estado HTTP claros.

Pronto para integrar a SMARTFENSE?

Explore a documentação completa da API ou contacte-nos para coordenar o acesso e esclarecer as suas dúvidas de integração.

A API faz parte da plataforma base da SMARTFENSE.

Ver a documentação

Solicitar acesso à API

Deixe-nos os seus dados e coordenamos o acesso à API e respondemos às suas questões de integração.