Introdução às REST APIs da KSI Vision

O que é uma REST API?

Uma REST API (Transferência de Estado Representacional) é um conjunto de regras que permite que programas se comuniquem entre si, expondo dados e funcionalidades via HTTP. Quando se menciona uma REST API, geralmente significa uma interface web com a qual você interage por meio de URLs usando verbos HTTP padrão (GET, POST, etc.).

As REST APIs da KSI Vision dão aos desenvolvedores acesso direto às análises da plataforma, dados de configuração e ingestão de eventos - sem precisar usar a interface web.

Autenticação Bearer

Todas as requisições à API da KSI exigem autenticação usando um Bearer Token. A autenticação Bearer é um esquema de autenticação HTTP onde um token de segurança - gerado pelo servidor no login - deve ser incluído no cabeçalho Authorization de cada requisição.

Pense assim: "dar acesso a quem carrega este token." O token é criptográfico, vinculado a uma conta específica e herda as permissões dessa conta.

Para saber como gerar seu token, consulte o guia de Autenticação.

Explorando a documentação da API

Após fazer login na plataforma KSI, você pode acessar a documentação interativa completa da API na seguinte URL:

• Américas: https://la.ksivision.com/api/docs
• Europa: https://eu.ksivision.com/api/docs

A documentação lista todos os endpoints disponíveis, suas entradas esperadas e a estrutura das respostas.

Exemplo: obter suas Locations

A requisição a seguir retorna uma lista de todas as Locations às quais sua conta tem acesso. Substitua API_TOKEN pelo seu Token de Acesso Pessoal (consulte o guia de Autenticação).

curl -H 'Accept: application/json' \
     -H "Authorization: Bearer API_TOKEN" \
     https://la.ksivision.com/api/locations

// Content-Type: application/json
[
  {
    "id": 0,
    "description": "string"
  }
]