API's de Integração


Atenção

A documentação poderá ser alterada sem aviso prévio.

Sobre nossa API

O principal objetivo da API da Nimbi é possibilitar que seu sistema faça praticamente  tudo que possa ser feito no Portal da Nimbi.

Nossos recursos vão ajudar você tanto a automatizar quanto melhorar tudo que você desejar no Nimbi.

Nós compartilhamos a mesma tecnologia que utilizamos internamente, então você tem a garantia de qualidade e que vamos estar constantemente melhorando.

Endereço de acesso para a documentação detalhada: nim.bi/api



O que é API?

Significa Application Programming Interface (em tradução livre, Interface de Programamção de Aplicativos).

A API da Nimbi trabalha como uma janela em que qualquer sistema com as permissões corretas pode acessar e automatizar as ações executadas via Portal Nimbi diretamente usando essa linguagem de programação.



Nós somos API RESTful

Nossas APIs são RESTful, que significa que você pode utilizar a URL para acessar vários recursos diferentes correspondentes com as aplicação que compõem o ecosistema da Nimbi, como por exemplo: /PurchaseOrde, /RFQ, /Requisition, e outros.



Segurança

Nós levamos a segurança dos nossos clientes muito a sério, então só trafegamos nossas APIs pelo protocolo HTTPS..



Tecnologia

Existem algumas coisas que você deve saber antes de usar nossas APIs.



HTTP

O Hypertext Transfer Protocol, sigla HTTP (em português Protocolo de Transferência de Hipertexto) é um protocolo de comunicação utilizado para sistemas de informação de hipermídia, distribuídos e colaborativos. Ele é a base para a comunicação de dados da Internet.
Saiba mais em https://pt.wikipedia.org/wiki/Hypertext_Transfer_Protocol.

REST

A Representational State Transfer (REST), em português Transferência de Estado Representacional, é um estilo de arquitetura que define um conjunto de restrições e propriedades baseados em HTTP.

Web Services que obedecem ao estilo arquitetural REST, ou web services RESTful, fornecem interoperabilidade entre sistemas de computadores na Internet em alguns formatos, no nosso caso o formato é JSON.



jSON

É um outro acrônimo de JavaScript Object Notation, é um formato compacto, de padrão aberto independente, de troca de dados simples e rápida (parsing) entre sistemas que utiliza texto legível a humanos, no formato atributo-valor (natureza auto-descritiva).

Isto é, um modelo de transmissão de informações no formato texto, muito usado em web services que usa transferência de estado representacional (REST).

Como é baseado em texto, deve ser codificado e nós usamos apenas UTF-8..


UTF-8

Todas as requisições e respostas das nossas APIs sempre serão codificadas em UTF-8. Não há outras possibilidades de codificação para nenhuma mensagem.

Esteja certo de que está usando a codificação correta antes de utilizar nossas APIs.

Ainda há outros padrões que você deve saber, como por exemplo o ISO 8601 para formato de datas.


ISO 8601

A ISO 8601 é uma norma internacional para representação de data e hora emitida pela Organização Internacional para Padronização (International Organization for Standardization, ISO).

Especificamente esta norma define: “Elementos de dados e formatos de intercâmbio para representação e manipulação de datas e horas”.

A principal característica do formato de data e hora da norma ISO 8601 é que a informação de data e hora seja ordenada a partir do valor mais significativo ou, em termos simples, do maior (o ano) para o menor (o segundo).

Agora que você está familiar com as tecnologias que nós utilizamos, você está apto a iniciar o uso das APIs da Nimbi. Você irá encontrar alguns exemplos de como utilizá-las na nossa página Como Usar.