All Net Redes Corporativas

All Net Redes Corporativas

  • Documentação

›Documentação

Documentação

  • Primeiros Passos
  • Fazendo sua Primeira Requisição

API

  • Dados dos Circuitos
  • Gráficos de Consumo, Latência e Uptime
  • Tráfego em Tempo Real
  • Exemplo de Aplicação em ReactJS

Fazendo sua Primeira Requisição

Verificando se o Token é válido no End-point

Recursos da API

Basicamente nossa API segue com uma rota de recurso e parâmetro. Nos exemplos abaixo utilizaremos o recurso de tokens /token e o parâmetro /validation, que resultará em uma resposta, se temos um Token válido ou não.

Conheceremos outros recursos e parâmetros da API mais adiante.

Métodos de Requisição

Podemos validar o Token de autenticação realizando requisições na API de diversas formas diferentes. Vamos ver algumas delas!

cURL

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

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }

jQuery

Necessário utilizar a biblioteca jQuery

  $.post("https://api.all.com.br/token/validation", 
  {'token':'<TOKEN>'}, function(data) {
    console.log(data)
  })

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }

Node.js

Necessário instalar o pacote request

npm install request --save ou yarn add request --save

  const request = require('request');

  const options = {
    url: 'https://api.all.com.br/token/validation',
    method: 'POST',
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    qs: {'token': '<TOKEN>'}
  }

  request(options, (error, response, body) => {
    if (!error && response.statusCode == 200) {
      console.log(body)
    }
  })

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }

PHP

  <?php
  $api = 'https://api.all.com.br/token/validation';

  $context = stream_context_create(array(
    'http' => array(
      'method' => 'POST',
      'header' => 'Content-type: application/x-www-form-urlencoded',
      'content' => http_build_query(
        array(
          'token' => '<TOKEN>',
        )
      ),
      'timeout' => 60
    )
  ));

  $res = file_get_contents($api, FALSE, $context);
  print_r($res);
  ?>

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }

Python

Necessário instalar o pacote requests

pip install requests ou pipenv install requests

  import requests
  r = requests.post('https://api.all.com.br/token/validation', json={'token': '<TOKEN>'})
  print r.json()

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }

Ruby

  require 'net/http'
  require 'uri'
  require 'json'

  uri = URI.parse("http://api.all.com.br/token/validation")

  header = {'Content-Type': 'application/x-www-form-urlencoded'}
  token = {'token':'<TOKEN>'}

  http = Net::HTTP.new(uri.host, uri.port)
  request = Net::HTTP::Post.new(uri.request_uri, header)
  request.body = token.to_json

  response = http.request(request)

  puts response.body

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

A resposta da API será o seguinte JSON:

  /* Token Válido */
  {
    status: "success"
  }
  
  /* Token Inválido */
  {
    status: "failed"
  }
← Primeiros PassosDados dos Circuitos →
  • Recursos da API
  • Métodos de Requisição
    • cURL
    • jQuery
    • Node.js
    • PHP
    • Python
    • Ruby
All Net Redes Corporativas
Docs
Começe Agora!Sistema de Gerência
Suporte
Envie suas dúvidas para
dev@all.com.br
Mais
BlogContato
Facebook Open Source
Todos os direitos reservados © 2018 All Net