# E-bees API - OpenAPI 3.0 ## Description This is version `1.0.0` of this API documentation. Last update on Aug 15, 2023. API que facilita transações entre demandantes e força de trabalho, com controle por checklists, notificações e gestão financeira. A API E-Bees está implementada em conformidade com o princípio de design REST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, PUT, GET, DELETE, para operações de leitura e escrita, bem como o modelo básico de autenticação HTTP. Suportamos chamadas diretas aos recursos/endpoints da API a partir de outras origens, CORS (cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web. Todas as respostas da API estão no formato de dados JSON, incluindo erros. Para fazer uso dos recursos da API E-Bees e transacionar online, utilize as credenciais compostas de e-mail e senha de acesso, que são disponibilizados ao contrato do serviço. # Authentication Nossas APIs permitem autenticação utilizando _JWT_ (Json Web Token) Você receberá as credenciais para o ambiente de produção e também para o ambiente de teste (sandbox). Além dessas credenciais, você também receberá os acessos ao dashboard de produção e teste para que possa acompanhar as transações geradas. Use a endpoint `/api/auth/login` para obter o token de acesso. Você deve enviar o token obtido em todas as requisições para as demais endpoints. # Tratamento de Erros ## Códigos de Status HTTP Os status http da API E-bees podem ser utilizados para sinalizar 3 modalidades principais: | Faixa de HTTP Status Code | Indica que... | | --- | --- | | 2xx | Tudo funcionou conforme esperado | | 4xx | O aplicativo fez algo errado (por exemplo, um parâmetro necessário faltou, algum dado inconsistente foi enviado ou a transação falhou) | | 5xx | A API fez algo errado e recebemos um log dessa falha para análise | Códigos http no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas e os códigos no intervalo 5xx indicam um erro com os servidores. A API E-Bees retorna códigos http apropriados para cada requisição. Na tabela abaixo você pode conferir os status code do http para os cenários possíveis: View More | HTTP Status | Texto | Descrição | | --- | --- | --- | | 200 | Ok | A requisição funcionou conforme esperado | | 201 | Created | A requisição foi bem sucedida e um novo recurso foi criado. | | 304 | Not Modified | Não haviam novos dados para retornar. | | 400 | Bad Request | A requisição foi inválida ou não chegou a ser processada pelo servidor. Pode indicar a falta de algum parâmetro obrigatório (na URL ou no body da requisição) | | 401 | Unauthorized | As credenciais de autenticação ou autorização (bearer token) informadas são inválidas | | 402 | Request Failed | Os parâmetros foram válidos, mas a requisição falhou | | 403 | Forbidden | A requisição foi ok, mas o acesso ao recurso não foi permitido. A mensagem de erro que acompanha o response explica o porquê. | | 404 | Not Found | A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído. | | 500 | Internal Server Error | Erro interno no servidor | | 502 | Bad Gateway | Simboliza que nesse exato instante a E-Bees está subindo uma versão nova. Aguarde alguns instantes e tente novamente | Contatos para suporte: Email: suporte@e-bees.com.br # Endpoints Abaixo você encontrará as endpoints disponíveis na nossa API que podem ser utilizadas para gerar e processar novas solicitações de serviço. A nossa API está em constante evolução e em breve teremos mais opções de endpoints. ## Servers ## Endpoints and operations ### [Autenticação](https://apidoc.e-bees.com.br/group/endpoint-autenticacao.md) - [Solicitar Token de Acesso](https://apidoc.e-bees.com.br/operation/operation-post-api-auth-login.md) ### [Public](https://apidoc.e-bees.com.br/group/endpoint-public.md) - [Consultar Serviços Disponíveis](https://apidoc.e-bees.com.br/operation/operation-get-api-home-servicos.md) - [Consultar Categorias de um Serviço](https://apidoc.e-bees.com.br/operation/operation-get-api-home-parameter-categorias.md) - [Consultar Produtos de uma Categoria](https://apidoc.e-bees.com.br/operation/operation-get-api-home-parameter-produtos.md) - [Detalhes de um Produto por Nome](https://apidoc.e-bees.com.br/operation/operation-get-api-home-produto-parameter.md) ### [Demanda de Serviço](https://apidoc.e-bees.com.br/group/endpoint-demanda-de-servico.md) - [Consultar Demanda por Identificador](https://apidoc.e-bees.com.br/operation/operation-get-api-pim-parameter.md) - [Detalhes de Demanda por URL Temporária](https://apidoc.e-bees.com.br/operation/operation-get-api-pim-u-parameter.md) - [Consultar Demandas de Serviço](https://apidoc.e-bees.com.br/operation/operation-post-api-pim-consulta.md) - [Registrar Demanda via Integração B2B](https://apidoc.e-bees.com.br/operation/operation-post-api-pim-b2b.md) - [Criar Nova Demanda de Serviço](https://apidoc.e-bees.com.br/operation/operation-post-api-pim.md) [Powered by Bump.sh](https://bump.sh)