Dados dos Circuitos

Acessando este recurso é possível obter um JSON com todos os circuitos cadastrados em sua conta.

Exemplo de Requisição

Neste exemplo utilizaremos apenas o cURL, pois pode ser facilmente utilizado em qualquer terminal de linha de comando.

Na seção Fazendo sua Primeira Requisição é possível encontrar uma variedade de outras linguagens que podem ser utilizadas por você.

Todos os Circuitos

Obtendo todos os circuitos associados.

Recurso: /circuits

curl -X POST -H 'Content-Type: application/json' -d '{"token":"<TOKEN>"}' https://api.all.com.br/circuits

Você deve substituir <TOKEN> pelo seu Token gerado no Sistema de Gerência.

A resposta da API será o seguinte JSON:

[
 {
  "usuario_nome": "Tesla Motors",
  "usuario_id": 10,
  "id_circuito": 1337,
  "circuito": "Fábrica Fremont",
  "velocidade": "500 Mbps",
  "designacao": "ALL-RJ-1337-10101",
  "disponibilidade": "99,9",
  "status": true
},
{
  "usuario_nome": "Tesla Motors",
  "usuario_id": 10,
  "id_circuito": 1338,
  "circuito": "Fábrica Xangai",
  "velocidade": "300 Mbps",
  "designacao": "ALL-RJ-1338-10102",
  "disponibilidade": "99,9",
  "status": true
},
]

Descrição dos Dados Retornados

Chave	Valor
usuario_nome	Nome da sua Empresa
usuario_id	Código do Usuário
id_circuito	Código do Circuito
circuito	Nome do Circuito
velocidade	Velocidade do Circuito
designacao	Designação do Circuito
disponibilidade	Qualidade da Disponibilidade do Circuito
status	Status do Circuito

Status: true para Circuito Online e false para Circuito Offline

Circuito Único

No exemplo acima temos a empresa Telas Motors, que possui dois circuitos. Por isso existem dois objetos na saída JSON.

Mas podemos obter apenas um dos circuitos informando um parâmetro para o recurso /circuits. Para isso, observe que temos a seguinte chave id_circuito no JSON retornado. "id_circuito": 1337 e "id_circuito": 1338

Esses valores serão utilizados como parâmetro em uma nova requisição para obtermos as informações completas de um determinado circuito.

Recurso: /circuits/<id_circuito>

curl -X POST -H 'Content-Type: application/json' -d '{"token":"<TOKEN>"}' https://api.all.com.br/circuits/1337

Observe que estamos utilizando o código 1337 do circuito Fábrica Fremont

Você deve substituir <TOKEN> pelo seu Token gerado no Sistema de Gerência.

Você deve também substituir o id_circuito pelo correspondente ao seu circuito.

A resposta da API será o seguinte JSON:

[
  {
    "usuario_nome": "Tesla Motors",
    "usuario_id": 10,
    "id_circuito": 1337,
    "circuito": "Fábrica Fremont",
    "velocidade": "500 Mbps",
    "designacao": "ALL-RJ-1337-10101",
    "gateway": "200.218.253.6",
    "bloco": "200.218.253.1/30",
    "mascara": "255.255.255.248",
    "ip_inicio": "200.218.253.1",
    "ip_fim": "200.218.253.5",
    "dns_primario": "200.218.248.2",
    "dns_secundario": "200.218.250.2",
    "disponibilidade": "99,9",
    "status": true
  }
]

Descrição dos Dados Retornados

Chave	Valor
usuario_nome	Nome da sua Empresa
usuario_id	Código do Usuário
id_circuito	Código do Circuito
circuito	Nome do Circuito
velocidade	Velocidade do Circuito
designacao	Designação do Circuito
gateway	Gateway do Circuito
bloco	Bloco de IP
mascara	Máscara de Sub-rede
ip_inicio	Primeiro IP Válido
ip_fim	Último IP Válido
dns_primario	Servidor DNS Primário
dns_secundario	Servidor DNS Secundário
disponibilidade	Qualidade da Disponibilidade do Circuito
status	Status do Circuito

Status: true para Circuito Online e false para Circuito Offline

Retorno de Erros da API

  /* Token Inválido */
  {
    status: "invalid token"
  }
  
  /* Acesso Restrito */
  {
    status: "invalid request"
  }

Invalid Request pode ocorrer quando se tenta informar um id_circuito que pode não estar associado a sua conta.

Exemplo

curl -X POST -H 'Content-Type: application/json' -d '{"token":"<TOKEN>"}' https://api.all.com.br/circuits/1337

Você deve substituir <TOKEN> pelo seu Token gerado no Sistema de Gerência.

Como o id_circuito 1337 não faz parte da sua conta, a API irá retornar o seguinte erro:

  { status: "invalid request" }