Documentação da API | Botelho Marketing

Como integrar

Autenticação:

Nossa API REST, utiliza o método de autenticação "Basic Auth", sendo necessário enviar os seguintes cabeçalhos à cada requisição feita:

Authorization: Basic hash_base64(clientId:clientSecret) e Content-Type: application/json

Credenciais:

Para obter as credenciais de acesso à API, acesse o menu "Integração > Credenciais" na área do usuário.

URL da API:

A URL base para envio das solicitações HTTP é:

https://app.botelhomarketing.com.br/api/v1/{endpoint}

Resposta:

Em todas as requisições será retornado um "body" no formato JSON, e também o respectivo código de status HTTP (200,400,etc...)

Endpoints

Os seguintes endpoints estão disponíveis em nossa API:

Produtos

Ação	Método	Endpoint	Observações
Listar Tudo	GET	`produtos`	(nenhuma)
Paginar	GET	`produtos/page/{numeroPagina}`	Limite de 20 resultados por página
Exibir	GET	`produtos/{idProduto}`	(nenhuma)

Pedidos

Ação	Método	Endpoint	Observações
Enviar	POST	`pedidos`	(nenhuma)
Listar Tudo	GET	`pedidos`	(nenhuma)
Paginar	GET	`pedidos/page/{numeroPagina}`	Limite de 20 resultados por página
Exibir	GET	`pedidos/{idPedido}`	(nenhuma)
Cancelar	PUT	`pedidos/cancel/{idPedido}`	(nenhuma)

Exemplos

Confira os seguintes exemplos:

Enviar Pedido

Necessário enviar no "body" da requisição, um objeto JSON com os seguintes dados:

{
    "data_chegada": "2024-05-21",
    "observacoes": "Pedido de teste",
    "destinatario": {
        "nome": "José", // obrigatório para pessoa física
        "sobrenome": "da Silva", // obrigatório para pessoa física
        "cargo": "Auxiliar",
        "tipo_pessoa": "fisica", // fisica ou juridica (letra minúscula e sem acentos)
        "cpf": "999.999.999-99", // disponível apenas para pessoa física
        "cnpj": "", // disponível apenas para pessoa jurídica
        "razao_social": "", // obrigatório para pessoa jurídica
        "nome_fantasia": "", // obrigatório para pessoa jurídica
        "telefone": "11988888888",
        "email": "jose.silva@email.com",
        "endereco": {
            "cep": "05117-080",
            "logradouro": "R. União da Vitória",
            "numero": "40",
            "complemento": "",
            "bairro": "Vila Jaguara",
            "cidade": "São Paulo",
            "uf": "SP",
            "pais": "Brasil"
        }
    },
    "itens": [
        {
            "id_produto": "2",
            "qtd": 2
        },
        {
            "id_produto": "3",
            "qtd": 1
        }
    ]
}