Modelagem da API

Padrões e Tecnologias

A API PIER {Labs} utiliza os conceitos de arquitetura RESTful, a qual conta com os seguintes padrões e tecnologias empregados na solução:

REST (Representational State Transfer): Arquitetura para a disponibilização de recursos através de sistemas distribuídos, popularmente utilizado sobre o protocolo HTTP.
Saiba mais em http://pt.wikipedia.org/wiki/REST

HTTP 1.1 (Hypertext Transfer Protocol): Padrão para descrição de dados utilizado para intercâmbio de informações entre sistemas, é mais simples e leve do que algumas alternativas de mercado, como XML.
Saiba mais em http://www.w3.org/Protocols/rfc2616/rfc2616.html e http://www.ietf.org/rfc/rfc2616.txt

JSON (JavaScript Object Notation): Protocolo de transporte padrão, amplamente utilizado.
Saiba mais em http://www.json.org e http://en.wikipedia.org/wiki/JSON

UTF-8 (8-bit Unicode Transformation Format): Conjunto de caracteres padrão para comunicação entre sistemas distribuídos.
Saiba mais em https://tools.ietf.org/html/rfc3629

ISO-8601 (Date and Time Formats): Padrão de preenchimento e apresentação dos campos de Data e Hora existentes nas operações de nossas APIs.
Saiba mais em https://www.w3.org/TR/NOTE-datetime

Endpoints

Nossa API conta apenas com dois endpoints de acesso aos serviços, um de SANDBOX e outro de PRODUÇÃO.

Enquanto o desenvolvedor estiver desenvolvendo a sua aplicação de forma integrada a nossa API, deve ser sempre utilizado o endpoint de Sandbox. Uma vez que a solução esteja integrada e testada, basta cadastrá-la em ambiente produtivo para obter o Access Token de produção e, assim, poder disponibilizá-la para os usuários.

Abaixo são apresentados os dois endpoints utilizados para acessar nossa API:

URL de Sandbox: https://sandbox.conductor.com.br

URL de Produção: https://api.conductor.com.br

Códigos de Retorno

As requisições processadas por nossa API retornarão códigos de resposta em HTTP, sendo as mais relevantes as descritas a seguir: