Consumindo um Endpoint

Usando os produtos e serviços da Insight Now através de nossa Web API

Para consumir os serviços do Insight Now é preciso acessar nossa Web API através do protocolo HTTP e acessar nossos recursos que usam a metodologia REST.

Nossos endpoints possuem alguns padrões na negociação de conteúdo que são detalhados abaixo.

JavaScript Object Notation (JSON)

Usamos JSON para a negociação de conteúdo por se tratar de uma notação simples e leve. Os dados que recebemos devem estar nesta notação, preferencialmente, bem como nossas respostas, que seguem este padrão.

Executando requisições

O protocolo HTTP é muito flexível e difundido, por isso há uma grande variedade de ferramentas que podem ser utilizadas para fazer requisições.

É comum que desenvolvedores façam alguns pequenos testes usando cURL ou clientes HTTP, como Insomnia ou Postman, antes de começarem a fazer integrações com seus sistemas. Mas indiferente da ferramenta que será usada, é preciso compor requisições no formato HTTP para interagir com a Web API da Insight.

Em alguns editores e IDEs, é possível escrever arquivos com extensão HTTP, que são executáveis através de uma ferramenta que realiza as requisições conforme as descritas.

O exemplo a seguir é uma requisição para nosso endpoint público de "check health".

POST https://api.cyberlabs.ai/rest/ping
User-Agent: my-agent/1.0
Content-Type: application/json
Authorization: insight Q0ktcGxHTVVTbGIzb21yVFNOUWtGdkk4b1ZzWkxlMndXNEk6Q1MtQ1hwRWJ2azg3Zm0xMEhrTnNwamV5Q2ZXUWtZd21ON0s=

{
  "username": "login",
  "password": "senha"
}

Veremos com mais detalhes quais são os endpoints disponíveis e como cada um deles pode ser utilizado.