[HSC MindAware] - Documentação API

Este procedimento tem o propósito de orientar de forma para utilizar a API da plataforma HSC MindAware.

Premissas

1. É necessário que o administrador tenha acesso e privilégios no HSC MindAware
2. Criar usuário e ativá-lo.

Informações

O Mindaware possui uma API que permite integração com aplicativos externos que utilizam o protocolo HTTPS e retorna no formato JSON.

Lista de rotas

O token de acesso deve ser incluído como um cabeçalho da solicitação em todas as chamadas de API marcadas com a opção "Utiliza Token" no seguinte formato:

Authorization: Bearer <token>

# Login da API

POST {{url}}/api/auth/login

➔ Request Body

email VALUE [nome  do usuário]

password  VALUE [senha do usuário]

➔ Retorno

{

    "access_token": "xxx",

    "token_type": "bearer",

    "expires_in": 7200,

    "user": {...},

    "company": {...},

    "module": {...},

    "two_factor_confirmed": 0

}

# Logout

POST {{url}}/api/auth/logout

➔ Retorno

{

    "message": "Usuário desconectado com sucesso!"

}

# Relatório de métricas educacionais

POST {{url}}/api/reports/users_courses

➔ Retorno

[

    {

        "name": "xxx",

        "mail": "xxx@xxx.xxx.xx",

        "type": "USER",

        "groups": "Grupo TODOS",

        "certification": "Não",

        "certification_date": null,

        "course_name": "Cyber Security Awareness Essentials",

        "course_status": "Não Iniciado",

        "course_start_date": null,

        "course_end_date": null,

        "has_completed": null

    },

    ...

...

]

# Lista de Campanhas

GET {{url}}/api/company_campaigns/

➔ Retorno

{

    "campaigns": [

        {

            "id": xx,

            "name": "Envios em horário específico",

            "date_start": "2022-08-15 00:00:00",

            "date_end": "2022-08-16 00:00:00",

            "custom_template": 0,

            "step_count": 1,

            "mail_from": "",

            "mail_subject": "",

            "mail_body": "",

            "name_template": null,

            "description_template": null,

            "thumbnail_template": null,

            "campaign_categories_id": null,

            "webpage_body": "",

            "trigger_time": 1,

            "trigger_schedule": "[{\"date\":\"15\\/08\\/2022\",\"hour\":\"17:00\"},{\"date\":\"15\\/08\\/2022\",\"hour\":\"22:00\"},{\"date\":\"16\\/08\\/2022\",\"hour\":\"08:00\"}]",

            "landing_page": "",

            "date_close": "2022-08-22",

            "created_at": "2022-08-15 13:20:51",

            "updated_at": null,

            "deleted_at": null

        },

        ...

    ...

    ]

...

}

# Relatório de métricas de comportamento

POST {{url}}/api/company_campaigns/triggersDetailsByUser/{{id_campanha}}

➔ Retorno

[

    {

        "campaign_name": "xxx",

        "user_name": "xxx",

        "mail": "xxx@xxx.xxx.xx",

        "category": "xxx",

        "template": "xxx",

        "status": "xxx",

        "timestamp": "xxxx-xx-xx xx:xx:xx"

    },

    ...

...

]

Dúvidas

Caso ainda tenha mais dúvidas quanto a esse procedimento, entre em contato conosco.

Related articles