MarketPlace Sul - Public API

(v.1.0)

Atenção: Todos os testes devem ser realizados em produção sem ônus ao desenvolvedor: todos as operações em produtos ou serviços realizados podem ser imediatamente alterados e/ou deletados(tanto pela API quanto pelo painel do lojista ou prestador de serviços).

Todas as APIs do MarketPlace Sul Developers foram desenvolvidas baseadas na tecnologia REST, seguindo os atuais padrões técnicos de mercado. Tudo isso para que a experiência na hora da integração seja a mais fácil possível. Todas as URLs são amigáveis e orientadas a recursos e utilizam os padrões do protocolo HTTP como autenticação, verbos e códigos de retorno. Isso permite que APIs possam ser utilizadas por clientes HTTP já existentes. Todas as respostas são retornadas no formato JSON.

Como pode ser visto abaixo, as APIs foram cuidadosamente trabalhadas para que os termos de negócios contidos sejam facilmente entendidos por desenvolvedores que não tenham conhecimento prévio do sistema. Elas foram meticulosamente estudadas para que um nome de campo em um endpoint tenha rigorosamente o mesmo significado em outros recursos.

Toda a comunicação (recebimento e envio de dados) utiliza tokens para autenticação. Veja na tabela abaixo quais são os tokens e os fluxos:

*Ambos os tokens serão fornecidos pelo MarketPlace Sul após a validação do cadastro de desenvolvedor.

Atenção: Lembramos que o time de desenvolvimento do MarketPlace Sul não presta serviços de consultoria, por isso, não analisaremos códigos em nosso suporte.

Seu sistema > MarketPlace Sul

x-ms-token

POST

MarketPlace Sul > Seu sistema

x-dev-token

GET

Respostas API

Atualize seu aplicativo

1001

202

Faltando informações

1002

403

Permissão negada por login inválido

1003

403

Loja não encontrada

1004

404

Loja criada com sucesso

1005

202

Loja deletada com sucesso

1006

202

Loja atualizada com sucesso

1007

202

Erro ao inserir loja

1008

500

Erro ao atualizar loja

1009

500

Erro ao deletar loja

1010

500

Permissão negada por tentativa de exclusão de agente não autorizado.

1011

403

Permissão negada por tentativa de alteração de agente não autorizado.

1012

403

Permissão negada por tentativa de inserção de agente não autorizado.

1013

403

Produto não encontrado

1014

404

Produto criado com sucesso

1015

202

Produto deletado com sucesso

1016

202

Produto atualizado com sucesso

1017

202

Erro ao inserir produto

1018

500

Erro ao atualizar produto

1019

500

Erro ao deletar produto

1020

500

Imagem não encontrada

1021

404

Imagem criada com sucesso

1022

202

Imagem deletada com sucesso

1023

202

Imagem atualizada com sucesso

1024

202

Erro ao inserir imagem

1025

500

Erro ao atualizar imagem

1026

500

Erro ao deletar imagem

1027

500

Serviço não encontrado

1028

404

Serviço criado com sucesso

1029

202

Serviço deletado com sucesso

1030

202

Serviço atualizado com sucesso

1031

202

Erro ao inserir Serviço

1032

500

Erro ao atualizar serviço

1033

500

Erro ao deletar serviço

1034

500

Profissional não encontrado

1035

404

Profissional criado com sucesso

1036

202

Profissional deletado com sucesso

1037

202

Profissional atualizado com sucesso

1038

202

Erro ao inserir Profissional

1039

500

Erro ao atualizar Profissional

1040

500

Erro ao deletar Profissional

1041

500

Ei, nós sabemos o que você está tentando fazer :)

1042

403

Erro desconhecido

1043

500

Falha na requisição

1044

500

Todas as APIs do MarketPlace Sul Developers retornam um JSON com no mínimo 3 filhos. O código - composto de 4 números, mensagem - resultado da solicitação feita a API, e o status - status HTTP composto de 3 números.

Caso haja alguma dúvida, não hesite em nos contactar.