Testar o access token

GET

/v1/ping

const url = 'https://sandbox-api.eagleix-corban.com.br/v1/ping';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://sandbox-api.eagleix-corban.com.br/v1/ping \
  --header 'Authorization: Bearer <token>'

Confirma que o access token é válido e mostra qual canal ele identifica. Útil como primeira chamada da integração.

Autorizações

canalOAuth

Respostas

200

Token válido e canal ativo.

application/json

object

canal

required

object

required

string format: uuid

nome

required

string

dbTime

required

Horário lido do banco.

string format: date-time

Example

{
  "canal": {
    "nome": "Bora"
  }
}

401

Token ausente, inválido ou expirado.

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized",
  "message": "token inválido ou expirado",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

Headers

WWW-Authenticate

string

Example

Bearer error="invalid_token"

403

Canal inativo ou requisição vinda de IP não autorizado.

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "forbidden",
  "message": "canal inativo",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

503

Banco de dados indisponível.

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "db_unavailable",
  "message": "banco indisponível",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}