Visão Geral da API Rest

Introdução

Este é o ponto de partida para entender a API REST da ONE. A API REST é uma interface de programação de aplicativos (API) que usa o protocolo HTTP para comunicação.

O que é uma API REST?

API é um conjunto de regras que especifica como diferentes aplicativos devem se comunicar entre si. O REST (Representational State Transfer) é um estilo de arquitetura para projetar APIs da Web.

Uma API RESTful é uma API que segue as restrições do estilo de arquitetura REST. Essas restrições são descritas em detalhes na dissertação do Fielding.

As APIs RESTful usam o HTTP como o protocolo subjacente para comunicação. Elas usam verbos HTTP para descrever a ação a ser executada no recurso identificado na URL. A resposta da API é geralmente um objeto JSON.

Acesso à API

O acesso à API exige autenticação, o que significa que você precisará se autenticar usando um par de chaves de API. Você pode criar e gerenciar suas chaves de API no menu Integração na página de configurações da empresa.

Recursos da API

A API REST da ONE oferece acesso a diferentes funcionalidades do sistema.
A documentação completa dos recursos da API pode ser encontrada na documentação a seguir.

Versionamento

A ONE usa um esquema de versionamento semântico para suas APIs REST. A versão atual da API é v1.

Quando uma nova versão da API é lançada, as alterações são documentadas na seção Notas de Lançamento.

Suporte

A ONE fornece suporte limitado para a API REST. Se você tiver problemas ao usar a API, entre em contato com o suporte da ONE.