PortalCredi

Health Check

GET/v1/healthcheck

Descrição

Cheque o estado da API e se você está conseguindo realizar requisições.

Autenticação

Você pode utilizar Tokens de Aplicação ou Tokens de Usuário.

Saiba mais sobre métodos de autenticação.

Parâmetros

Nenhum parâmetro necessário.

Resposta

Chave Valor Descrição
message OK Sucesso. A API está funcionando.

Exemplos

Requisição

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.portalcredi.com.br/v1/healthcheck',
  headers: {
    'Authorization': 'Bearer 999999-999999-999999-999999-999999-999999'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

copiar exemplo

Resposta

{
    "success": true,
    "message": "OK"
}

copiar resposta