ORA.API

Ela oferece acesso aos recursos por meio de URIs e opera sobre o protocolo HTTP, facilitando o uso em qualquer linguagem de programação ou framework. Para utilizar a API, sua aplicação deve enviar uma requisição HTTP e analisar a resposta retornada.

O formato de dados utilizado para entrada e saída é o JSON. Para todas as requisições POST e PUT, o cabeçalho deve conter o formato application/json; charset=utf-8.

​

Você pode utilizar os seguintes verbos HTTP padrão de acordo com a ação desejada:

​

Verbo                                        Função geral

GET                                           Consulta dados. Fornecer apenas os parâmetros de filtro na queryString.

PUT                                           Atualiza um ou poucos dados específicos. É necessário fornecer um JSON no corpo da requisição.

POST                                        Insere ou atualiza dados mais complexos. É necessário fornecer um JSON no corpo da requisição.

DELETE                                    Apaga dados. Não é necessário fornecer um corpo na requisição.

​

A descrição de cada endpoint informa qual verbo está disponível para o respectivo recurso.

​

​

Formato das URIs

O formato das URIs para os endpoints da Colibri API segue a seguinte estrutura:

http://[url]/api/[endpoint]/[&parametro1&parametroN]

​

Elemento                                  Descrição

URL                                           URL Base da API

Endpoint                                   Destino que deseja acessar na API

parametro1-paramentroN     Parâmetros que podem ser fornecidos via QueryString.

​

​

Token Partner Key

O Token Partner Key (chave da API) é um UUID gerado pela PLAN SISTEMAS e que identifica exclusivamente a solução de um parceiro, e a origem das requisições. Este token deve ser enviado em toda requisição, no cabeçalho

Os endpoints funcionam apenas se a chave de API da solução parceira estiver presente. Se o token estiver desativado, os endpoints retornarão um erro 404 com a mensagem de erro.

Para incluir a chave de parceiro, é necessário solicitar sua adição à PLAN SISTEMAS, fornecendo informações sobre a solução parceira e solução de acesso.

​​

​

Formato e codificação do JSON

Nas requisições  POST  e  PUT  que exigem o envio de um  JSON  no corpo da solicitação,   é necessário incluir no cabeçalho a seguinte chave:

Content-Type: application/json; charset=utf-8. Esse parâmetro é essencial para garantir que o sistema trate corretamente os caracteres acentuados.

​

​

Segurança

Endpoints que disponibilizam informações de autorização e segurança essenciais para soluções que utilizam a API.

​

​

Acesso ao Postman

https://documenter.getpostman.com/view/798466/2s9Xy3sWfL

​