Colibri Integration Service

A NCR Colibri REST API é uma interface padrão para interagir com o NCR Colibri Desktop.

A API REST provê acesso aos recursos através de URIs. Para usar a API REST, sua aplicação deve fazer uma requisição HTTP e analisar a resposta. Você deve utilizar os métodos padrões do HTTP como GET, PUT, POST e DELETE. A NCR Colibri REST API opera sobre o protocolo HTTP(s) tornando seu uso fácil por qualquer linguagem de programação ou framework.

O formato de dados de entrada e de saída utilizado pela NCR Colibri REST API é o JSON. Enviar no header de todas as requisições POST e PUT o formato application/json; charset=utf-8.

Formato das URIs

As URIs para os recursos da NCR Colibri REST API seguem a seguinte estrutura:

[http://servidor:porta/versao-api/nome-recurso/?api_key[&parametro1&parametroN]

  • Versão da API: A versão atual da API é v1.
  • Nome do recurso: Consulte a documentação para conhecer os recursos disponíveis.
  • API key: A chave de API é um código de licença utilizado para identificar unicamente a solução de um parceiro que está utilizando a API REST. A API REST pode ser consumida somente se a chave de API está presente na licença do estabelecimento, ou seja, se o estabelecimento não estiver habilitado para funcionar com uma determinda Api key, deve-se solicitar à revenda ou à NCR a liberação. IMPORTANTE: Este parâmetro é mandatório e deve ser enviado em TODAS as requisições feitas à API Rest do CIS (Colibri Integration Service).

Autenticação

A NCR Colibri REST API suporta autenticação básica usando um token base64 nos cabeçalhos dos request.

Authorization: Basic TOKEN==

onde TOKEN é um base64('usuario:senha')

Formato e codificação do JSON

Em requisições POST e PUT que exigem o envio de um JSON no corpo da requisição é necessário informar no header a chave Content-Type:application/json; charset=utf-8.

Esse parâmetro é essencial para que o sistema trate corretamente caracteres acentuados.

PUBLISHER

NCR Brasil Dev
NCR Colibri Agile Team

CATEGORIES

Imports

20+