Myse - Soluções na nuvem para gestão de negócios.

Navegação

Introdução
Padronização
Segurança
Recursos
Modelos

Introdução

A API de pedidos foi criada pensando em automatizar e simplificar a criação de pedidos.

Trabalhamos com a persistência de clientes, produtos dessa forma a criação de pedidos fica ainda mais fácil.

Nossa documentação busca detalhar e explanar todos os recursos, mas caso alguma dúvida surja, entre em contato conosco.

Padronização

Nossa API foi projetada utilizando o conceito de serviços REST, charset UTF-8 e formato JSON para troca de mensagens (requisição e resposta).

Tecnologia	Descrição
REST	Modelo arquitetural que consiste de um conjunto coordenado de restrições aplicadas a componentes, conectores e elementos de dados dentro de um sistema distribuído.
UTF-8	Tipo de codificação Unicode de comprimento variável. Pode representar qualquer caracter Unicode, sendo também compatível com o ASCII.
JSON	Formato leve para troca de informações entre aplicações. Embora seja um acrônimo para JavaScript Object Notation, pode ser utilizado independentemente de linguagem de programação.

Para trabalhar em cada recurso, a integração deverá utilizar os quatro principais verbos existentes do protocolo HTTP: GET, POST, PUT e DELETE.

Verbo	Objetivo
GET	Deverá ser utilizado sempre que o objetivo for obter informações sobre determinado recurso. Por exemplo: listar clientes ou listar pedidos.
POST	Deverá ser utilizado sempre que o objetivo for salvar uma nova instância de algum recurso. Por exemplo: salvar novo cliente ou criar um novo pedido.
PUT	Deverá ser utilizado sempre que o objetivo for alterar ou completar informações sobre determinada instância de algum recurso. Por exemplo: alterar preço do produto ou alterar endereço do cliente.
DELETE	Deverá ser utilizado sempre que o objetivo for remover uma instância de algum recurso. Por exemplo: excluir cliente ou excluir produto.

Segurança

Todas as requisições de serviços devem ser autenticadas por um Token, garantindo a segurança dos dados de cada cliente. O Token é único de cada empresa, sendo gerado na aba Integração, em Meus Dados, dentro do painel do sistema.

Caso possua acesso ao Painel de Gestão de Contas, é possível gerar Tokens para cada empresa administrada diretamente nele.

No cabeçalho da requisição HTTP o parâmetro Authorization deve conter o valor "Token {token da empresa}", já o parâmetro Content-Type deve conter o valor "application/json".

Authorization: Token {token da empresa}
Content-Type: application/json

Após isso, defina a URI da requisição, verbo HTTP para definir a ação a ser executada no recurso, o conteúdo da mensagem (se for o caso) e analise o retorno.

Recursos

Veja abaixo todos os recursos expostos no momento e como interagir com cada um deles.

Para realizar as requisições de nossa API utilize o link abaixo como ponto de requisição.

https://app.myse.com.br:8443/pedido-api/rest/

Status de retorno

Abaixo estão destacados os possiveis códigos de status para realizar a identificação da situação em que se encontra os dados da requisição.

Todo status vem acompanhado de uma descrição para facilitar a leitura do retorno.