Índice:

Objetivo:
Configuração:

Objetivo:

Este documento tem como finalidade, demonstrar o utilização da API Rest HealthCheck evidenciando os serviços:

/api/v1/healthcheck/License

Configuração:

Configuração

Informações Gerais

Serviço /License/

Objetivo: Testar a conexão com o License Server
Detalhamento: Para consumir o serviço /License/ utilize a seguinte rota: /api/v1/healthcheck/license/.
Exemplo de Utilização:

Retorno

Descrição: Retorno do serviço /License/.
Tipo: Cadeia de Caracteres (String)

Estrutura de retorno [FI001 - Sucesso]:

Retorno (Sucesso)

{
    "status": "Servidor do License Server Ativo",
    "returnCode": 2014,
    "message": {
        "code": "FI001",
        "message": "Sucesso",
        "detailedMessage": "Tentativa de conexão com o servidor do License Server realizado com sucesso!",
        "details": []
    }
}

Estrutura de retorno [FW001 - Alerta]:

Retorno (Sucesso)

{
    "status": "Servidor do License Server Ativo",
    "returnCode": -9,
    "message": {
        "code": "FW001",
        "message": "Alerta",
        "detailedMessage": "A data do servidor de Aplicação difere da data do servidor de Licenças. Procure o Administrador do Sistema.",
        "details": [
            {
                "code": "FE007",
                "message": "Stack Trace",
                "detailedMessage": "   em RM.Lib.Server.RMSLicenseServerCloud.GetVersion(String serverIP, Int32 serverPort, String clientIP, Int32 clientPort, Int32 MDIThreadId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\LicenseServer\\RMSLicenseServerCloud.cs:linha 428\r\n   em RM.Lib.LicenceServer.RMSLicenseClientCloud.GetVersion() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicenseClientCloud.cs:linha 297\r\n   em RM.Lib.LicenceServer.RMSLicenseClientBase.get_Version() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicenseClientBase.cs:linha 124\r\n   em RM.Lib.RMSLicence.get_Version() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicence.cs:linha 60\r\n   em RM.Lib.Server.RMSHealthCheckMod.CheckLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 30",
                "details": []
            }
        ]
    }
}

Estrutura de retorno [FW002 - Alerta]:

Retorno (Erro)

{
    "status": "Servidor do License Server Inativo",
    "returnCode": -10008,
    "message": {
        "code": "FW002",
        "message": "Alerta",
        "detailedMessage": "Falha ao abrir uma conexão socket com Licence Server no endereço 10.31.0.0:5555. Verificar se a rede está conectada e/ou o Licence Server está ativo.\r\nUma tentativa de conexão falhou porque o componente conectado não respondeu\r\ncorretamente após um período de tempo ou a conexão estabelecida falhou\r\nporque o host conectado não respondeu 10.31.0.0:5555 ",
        "details": [
            {
                "code": "FE007",
                "message": "Stack Trace",
                "detailedMessage": "   em TOTVS.Licence.LSCloud.LSCloudClientSocket.Connect()\r\n   em TOTVS.Licence.LSCloud.LSCloudClientSocket.LSGetVersion()\r\n   em RM.Lib.Server.RMSLicenseServerCloud.GetVersion(String serverIP, Int32 serverPort, String clientIP, Int32 clientPort, Int32 MDIThreadId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\LicenseServer\\RMSLicenseServerCloud.cs:linha 404\r\n   em RM.Lib.LicenceServer.RMSLicenseClientCloud.GetVersion() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicenseClientCloud.cs:linha 297\r\n   em RM.Lib.LicenceServer.RMSLicenseClientBase.get_Version() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicenseClientBase.cs:linha 124\r\n   em RM.Lib.RMSLicence.get_Version() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\LicenceServer\\RMSLicence.cs:linha 60\r\n   em RM.Lib.Server.RMSHealthCheckMod.CheckLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 30",
                "details": []
            },
            {
                "code": "FE007",
                "message": "Stack Trace",
                "detailedMessage": "   em System.Net.Sockets.Socket.DoConnect(EndPoint endPointSnapshot, SocketAddress socketAddress)\r\n   em System.Net.Sockets.Socket.Connect(EndPoint remoteEP)\r\n   em System.Net.Sockets.TcpClient.Connect(IPEndPoint remoteEP)\r\n   em System.Net.Sockets.TcpClient.Connect(IPAddress address, Int32 port)\r\n   em TOTVS.Licence.LSCloud.LSCloudClientSocket.Connect()",
                "details": []
            }
        ]
    }
}

Estrutura de retorno [FE006 - Erro]:

Retorno (Erro)

{
    "code": "FE006",
    "message": "Erro",
    "detailedMessage": "RMSHealthCheck - Método CheckLicense()",
    "helpUrl": "",
    "details": [
        {
            "code": "FE007",
            "message": "Stack Trace",
            "detailedMessage": "   em RM.Lib.Server.RMSSecurityUtilsMod.GetDbAlias(String alias) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSSecurityUtilsMod.Login.cs:linha 145\r\n   em RM.Lib.Server.RMSLoginServer.GetDbAlias(String alias) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 81\r\n   em RM.Lib.Server.RMSLoginServer.ExecuteService(String alias, String serviceId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 198\r\n   em RM.Lib.Server.RMSHealthCheckServer.ServiceAuthenticate(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Servers\\RMSHealthCheckServer.cs:linha 66\r\n   em RM.Lib.Server.RMSHealthCheckServer.CheckLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Servers\\RMSHealthCheckServer.cs:linha 21\r\n   em RM.Lib.Server.healthcheck.CheckLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Api's\\healthcheck.cs:linha 31",
            "helpUrl": "",
            "details": []
        }
    ]
}

Atributos de Retorno

Status (Sucesso e Alertas)

Descrição: Situação do License Server.
Tipo: String
Possíveis Valores:
• Servidor do License Server Ativo
• Servidor do License Server Inativo
Informações relevantes: O status se refere a situação do License Server. Caso a conexão com o License Server tenha sido realizada com sucesso o status de Ativo será apresentado, caso contrário o status de Inativo será apresentado.

ReturnCode (Sucesso e Alertas)

Descrição: Código Enviado pelo License Server
Tipo: int
Possíveis Valores:
• 2014 (Sucesso)
• -99 (Alerta - Versão Incompativel)
• -9 (Alerta - Data conflitante)
• -10008 (Alerta - License Server Offline)
Entre muitos outros valores...
Informações relevantes: O ReturnCode se refere ao código retornado pelo License Server. Os códigos apresentados indicam a situação do License Server, se ele está ativo, inativo, se algum erro de conexão aconteceu, se o ERP está com uma versão incompatível do License Server e etc....

Message - Code (Sucesso, Alertas e Erros)

Descrição: Código da Mensagem
Tipo: String
Possíveis Valores:
• FI00X (Informação)
• FW00X (Alerta)
• FE00X (Erro)
Informações relevantes: O status se refere ao código da mensagem retornado pela api. Os códigos apresentados podem ser de informação (no caso de sucesso), de alerta (no caso de algum erro de negócio acontecer) e de erro (no caso de alguma exceção não tratada.

Message - Message (Sucesso, Alertas e Erros)

Descrição: Descrição do Código
Tipo: String
Possíveis Valores:
• Sucesso
• Alerta
• Erro
Informações relevantes: O atributo message, nada mais é do que a descrição do código apresentado. O código FI00X indica sucesso ao consumir a api e sucesso ao aplicar corretamente a regra de negócio, o código FW00X indica sucesso ao consumir a api, porém falha na aplicação da regra de negócio e o código FE00X indica falha no consumo da api.

Message - DetailedMessage (Sucesso, Alertas e Erros)

Descrição: Mensagem detalhada
Tipo: String
Possíveis Valores:
• No caso de sucesso: Tentativa de conexão com o servidor do License Server realizado com sucesso!
• No caso de alertas e erros: Variados valores.
Informações relevantes: O atributo detailedMessage trás uma descrição mais amigável do resultado do consumo da api. A mensagem de sucesso é unica e padronizada, enquanto que as mensagens de alerta e de erro podem ser variadas, devido as variadas possibilidades de retorno.

Message - HelpUrl (Erros)

Descrição: Url de Ajuda
Tipo: String
Possíveis Valores:
• Uma Url qualquer
Informações relevantes: O atributo helpUrl é uma página da internet que explique melhor uma funcionalidade, ou um erro apresentado, afim de ajudar o usuário a entender melhor uma funcionalidade para o correto uso da mesma, ajudá-lo a reportar à Totvs algum erro evidenciado pela api.

Message - Details (Sucesso, Alertas e Erros)

Descrição: Detalhes sobre a mensagem apresentada.
Tipo: Cadeia de Caracteres (String)
Possíveis Valores:
• Um conjunto qualquer de mensagens.
Informações relevantes: O atributo Details é uma lista de mensagens que corroboram com a mensagem detalhada. Essas mensagens, por exemplo, podem ser o trecho de código onde o erro aconteceu.

Atalhos

Páginas filhas

Índice:

Objetivo:

Configuração: