Í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/Get

Configuração:

Configuração

Informações Gerais

Serviço /License/Get

Objetivo: Testar o consumo de uma licença de teste
Detalhamento: Para consumir o serviço /License/Get utilize a seguinte rota: /api/v1/healthcheck/license/get.
Exemplo de Utilização:

Retorno

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

Estrutura de retorno [FI002 - Sucesso]:

Retorno (Sucesso)

{
    "status": "Licença Consumida",
    "returnCode": 2014,
    "message": {
        "code": "FI002",
        "message": "Sucesso",
        "detailedMessage": "A licença de teste foi consumida com sucesso!",
        "details": []
    }
}

Estrutura de retorno [FW003 - Alerta]:

Retorno (Sucesso)

{
    "status": "Licença Não Consumida",
    "returnCode": -1505,
    "message": {
        "code": "FW003",
        "message": "Alerta",
        "detailedMessage": "Excedeu numero de licenças",
        "details": []
    }
}

Estrutura de retorno [FE006 - Erro]:

Retorno (Erro)

{
    "code": "FE006",
    "message": "Erro",
    "detailedMessage": "RMSHealthCheck - Método ConsumeLicense()",
    "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.ConsumeLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Servers\\RMSHealthCheckServer.cs:linha 35\r\n   em RM.Lib.Server.healthcheck.ConsumeLicense() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Api's\\healthcheck.cs:linha 64",
            "helpUrl": "",
            "details": []
        }
    ]
}

Estrutura de retorno [FE008 - Erro]:

Retorno (Erro)

{
    "code": "FE008",
    "message": "Erro",
    "detailedMessage": "Falha na tentativa de consumir a licença de teste!",
    "helpUrl": "",
    "details": []
}

Atributos de Retorno

Status (Sucesso e Alertas)

Descrição: Situação do consumo da licença de teste.
Tipo: String
Possíveis Valores:
• Licença Consumida
• Licença Não Consumida
Informações relevantes: O status se refere a situação do consumo da licença de teste. Caso o consumo da licença de teste tenha sido realizada com sucesso o status de Consumida será apresentado, caso contrário o status de Não Consumida será apresentado.

ReturnCode (Sucesso e Alertas)

Descrição: Código Enviado pelo License Server
Tipo: int
Possíveis Valores:
• 2014 (Sucesso)
• -1505 (Alerta - Numero de licenças excedidas)
• -1507 (Alerta - Licenças em uso)
• -10001 (Alerta - LSC_Error - O atributo () não foi enviado)
Entre muitos outros valores...
Informações relevantes: O ReturnCode se refere ao código retornado pelo License Server ao tentar consumir a licença de teste. Os códigos apresentados indicam a situação do consumo da licença de teste, se ela foi consumida ou não, se algum erro de conexão com o License Server aconteceu 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: A licença de teste foi consumida com sucesso!
• No caso do erro FE008: Falha na tentativa de consumir a licença de teste!
• No caso dos demais 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: