Português
English
Introdução
Conecte-se ao ecossistema Sotreq através de nossas APIs de integração. Desenvolvidas para serem simples, ágeis e consistentes, elas são a ponte para que nossos parceiros criem soluções inovadoras.Com nossa plataforma, você desenvolve aplicações personalizadas para otimizar a gestão de produtos, peças e serviços, integrando seus sistemas diretamente aos nossos. Oferecemos todas as ferramentas e o suporte necessários para garantir uma conexão robusta e eficiente.
Ambientes
| Ambiente | Endpoint |
|---|---|
|
Sandbox: Para realizar os primeiros testes na API e visualizar retornos mockados para agilizar o desenvolvimento de suas aplicações. Neste ambiente, não será necessário realizar autenticação. |
|
|
Homologação: Para executar testes integrados com a Sotreq seguindo os cenários de teste funcionais do produto ou serviço fornecido pela API. A partir desse ambiente, será necessário realizar autenticação. |
|
|
Produção: Para utilizar as APIs conectando sua solução e gerando valor. |
Consumindo uma API
Para consumir as APIs é necessário criar um APP, escolher o fluxo de autenticação conforme a API escolhida e verificar os resultados inicialmente no ambiente de homologação.
Criar um novo APP
Siga o passo a passo para criar seu novo APP e no final você receberá o Client ID e Client Secret para consumir as APIs.- Acesse a página Minhas Apps e selecione Cadastrar Nova App
- Preencha os campos obrigatórios e selecione as APIs que seu App irá consumir e no final clicar no botão Registrar
Catálogo de Integrações
Cada API possui suas particularidades, desde os métodos de autenticação e fluxos de trabalho até as formas específicas de acesso. Acesse aqui a documentação de cada uma das APIs.Status code
Os Códigos de Status HTTP (Hypertext Transfer Protocol) são respostas padronizadas de três dígitos que um servidor web envia ao navegador ou cliente que fez uma requisição. Cada código informa o resultado da requisição, indicando se ela foi bem-sucedida, se houve um erro, ou se alguma outra ação é necessária.| Código | Erro | Descrição |
|---|---|---|
|
200 |
OK |
Sucesso. |
|
400 |
Bad Request |
A requisição possui parâmetro(s) inválido(s). |
|
401 |
Unauthorized |
O token de acesso não foi informado ou não possui acesso as APIs. |
|
404 |
Not Found |
O recurso informado no request não foi encontrado. |
|
413 |
Request is to Large |
A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso. |
|
422 |
Unprocessable Entity |
A requisição possui erros de negócio. |
|
429 |
Too Many Requests |
O consumidor estourou o limite de requisições por tempo. |
|
500 |
Internal Server Error |
Erro não esperado, algo está quebrado na API. |
