Govoni Marketing - Agência de marketing digital em Porto Alegre

Introdução

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis mattis vitae dolor vitae tristique. Aliquam dolor urna, aliquet eu dui at, mollis consectetur risus. Aliquam erat volutpat. In a augue et ante iaculis scelerisque id in lacus. Aenean eu mollis nunc. Phasellus placerat id justo ac scelerisque. Praesent pharetra, nulla vel vulputate consequat, libero tellus iaculis ex, eget imperdiet tellus ipsum viverra ante. Vivamus rutrum in dui non cursus. Proin maximus suscipit hendrerit. Nunc finibus enim eget porta finibus. Praesent sit amet odio odio.

Base URL

A base URL para a API de Categorias é:

http://example.com/api/v1/

Requisições HTTP

As requisições HTTP são feitas através de um cliente HTTP, como o cURL, Postman, Insomnia, etc. A API de Categorias suporta os seguintes métodos HTTP:

tabela que lista os métodos e suas descriçoes

Método	Descrição
GET	Retorna uma ou várias categorias.
POST	Cria uma nova categoria.
PUT	Edita uma categoria existente.
DELETE	Deleta uma categoria existente.

Documentação da API de Categorias

A API de Categorias permite que você liste, crie, edite e delete categorias. As categorias são usadas para organizar e agrupar informações em uma estrutura hierárquica.

Listar Categorias

Para listar todas as categorias, faça uma requisição GET para a URL base da API de Categorias:

GET base_url/categorias

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_categoria	int	Retorna uma categoria específica.
cod_ant	int	Retorna uma categoria específica através do código antigo.
limite	int	Retorna um número específico de categorias.
inicio	int	Retorna a partir de um número específico de categorias.

Exemplo

GET /categorias?id_categoria=1&cod_ant=12345&limite=10&inicio=0

Resposta

{
        "status": "OK",
        "categorias": [
            {
            "id_categoria": 1,
            "nome": "Categoria A",
            "cod_ant": "12345"
            },
            {
            "id_categoria": 2,
            "nome": "Categoria B",
            "cod_ant": "23456"
            }
        ]
        }

Criar Categoria

Cria uma nova categoria.

POST /categorias

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da categoria.

Exemplo

{
  "nome": "Categoria C"
}

Resposta

{
  "status": "OK",
  "id_categoria": 3
}

Editar Categoria

Edita uma categoria existente.

PUT /categorias/{id_categoria}

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da categoria.

Exemplo

{
  "nome": "Categoria D"
}

Resposta

{
  "status": "OK"
}

Deletar Categoria

Deleta uma categoria.

PUT /categorias/{id_categoria}

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_categoria	int	Id da categoria para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/categorias/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Categoria não encontrada"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de sub categorias

A API de Categorias Sub permite listar, criar, atualizar e deletar categorias secundárias de uma categoria principal.

Listar sub Categorias

Para listar todas as sub categorias, faça uma requisição GET para a URL base da API de Categorias:

GET base_url/categorias

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_categoria	int	Retorna um grupo de sub categorias específica.
id_categoria_sub	int	Retorna uma sub categoria específica.
cod_ant	int	Retorna uma sub categoria específica através do código antigo.
limite	int	Retorna um número específico de categorias.
inicio	int	Retorna a partir de um número específico de categorias.

Exemplo

GET /categorias_sub?id_categoria=1&cod_ant=12345&limite=10&inicio=0

Resposta

{
    "status": "OK",
    "categorias_sub": [
        {
            "id_categoria_sub": 1,
            "id_categoria": 1,
            "nome": "Categoria Sub 1",
            "cod_ant": "COD001"
        },
        {
            "id_categoria_sub": 2,
            "id_categoria": 1,
            "nome": "Categoria Sub 2",
            "cod_ant": "COD002"
        },
        {
            "id_categoria_sub": 3,
            "id_categoria": 1,
            "nome": "Categoria Sub 3",
            "cod_ant": "COD003"
        }
    ]
}

Criar sub Categoria

Cria uma nova categoria.

POST /categorias_sub

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_categoria	int	Categoria a qual pertence
nome	string	Nome da sub categoria.
cod_ant(opicional)	int	Código anterior

Exemplo

POST /categorias_sub
Content-Type: application/json

{
    "id_categoria": 1,
    "nome": "Nova Categoria Sub",
    "cod_ant": "COD004"
}

Resposta

{
    "status": "OK",
    "id_categoria_sub": 4
}

Editar sub Categoria

Edita uma sub categoria existente.

PUT /categorias_sub/{id}

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da sub categoria.

Exemplo

PUT /categorias_sub/4
Content-Type: application/json

{
    "nome": "Categoria Sub Atualizada"
}

Resposta

{
    "status": "OK"
}

Deletar sub Categoria

Deleta uma sub categoria.

DELETE /categorias_sub/{id_categoria}

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_sub_categoria	int	Id da sub categoria para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/subcategorias/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Sub Categoria não encontrada"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de Clientes

A API de Clientes permite a listagem, criação, edição e exclusão de registros de clientes. Abaixo estão as informações detalhadas de cada método.

Listar Cliente

Para listar todos os cliente, faça uma requisição GET para a URL base da API de Clientes:

GET base_url/clientes

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_cliente	int	Filtro para listar clientes com um ID específico
cod_ant	int	Retorna em específico através do código antigo.
limite	int	Retorna um número específico.
inicio	int	Retorna a partir de um número específico.

Exemplo

GET /clientes?id_cliente=1&&limite=10&inicio=0

Resposta

{
    "status": "OK",
    "clientes": [
        {
            "id_cliente": 1,
            "nome": "João da Silva",
            "email": "joao@exemplo.com",
            "telefone": "(11) 9999-9999",
            "cod_ant": "ABC123",
            "data_cadastro": "2022-01-01 10:00:00"
        },
        {
            "id_cliente": 2,
            "nome": "Maria Souza",
            "email": "maria@exemplo.com",
            "telefone": "(11) 8888-8888",
            "cod_ant": "DEF456",
            "data_cadastro": "2022-01-02 14:30:00"
        }
    ]
}

Criar Cliente

Cadastra um novo cliente.

POST /clientes

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da sub categoria.
email	string	Endereço de e-mail do cliente.
telefone	string	Número de telefone do cliente.
cod_ant(opicional)	int	Código anterior

Exemplo

POST /api/v1/clientes
Content-Type: application/json

{
    "nome": "Fulano de Tal",
    "email": "fulano@exemplo.com",
    "telefone": "(11) 7777-7777",
    "cod_ant": "GHI789"
}

Resposta

{
    "status": "OK",
    "id_cliente": 3
}

Editar Cliente

Edita um cliente existente.

PUT /clientes/{id}

Parâmetros

A API de Clientes suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da sub categoria.
email	string	Endereço de e-mail do cliente.
telefone	string	Número de telefone do cliente.

Exemplo

PUT /cliente/4
Content-Type: application/json

{
    "nome": "teste",
    "email": "email@email.com",
    "telefone": "51999999999"
}

Resposta

{
    "status": "OK"
}

Deletar cliente

Deleta um cliente.

DELETE /cliente/{id}

Parâmetros

A API de cliente suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_cliente	int	Id do cliente para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/cliente/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Sub Categoria não encontrada"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de Marcas

Esta API permite gerenciar as marcas de produtos cadastradas em um sistema. Através desta API, é possível realizar operações de listagem, inclusão, alteração e exclusão de marcas.

Listagem de marcas

Para listar todas as marcas, faça uma requisição GET para a URL base da API de Marcas:

GET base_url/marcas

Parâmetros

A API de Marcas suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_marca	int	ID da marca a ser filtrada
cod_ant	int	Retorna em específico através do código antigo.
limite	int	Retorna um número específico.
inicio	int	Retorna a partir de um número específico.

Exemplo

GET /marcas?id_marca=1&&limite=10&inicio=0

Resposta

{
    "marcas": [
        {
            "id_marca": "1",
            "nome": "Marca A",
            "cod_ant": "A001"
        },
        {
            "id_marca": "2",
            "nome": "Marca B",
            "cod_ant": "B002"
        },
        ...
    ],
    "status": "OK"
}

Criar Marca

Cadastra uma nova Marca.

POST /marcas

Parâmetros

A API de Categorias suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da marca.
cod_ant(opicional)	int	Código anterior

Exemplo

POST /marcas
Content-Type: application/json

{
    "nome": "Nova Marca",
    "cod_ant": "N001"
}

Resposta

{
    "id_marca": "3",
    "status": "OK"
}

Alteração de marca

Edita uma marca existente.

PUT /marcas/{id}

Parâmetros

A API de Marcas suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome da marca.

Exemplo

PUT /marcas/3
Content-Type: application/json

{
    "nome": "Marca Alterada"
}

Resposta

{
    "status": "OK"
}

Deletar marca

Deleta uma marca.

DELETE /marcas/{id}

Parâmetros

A API de marca suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id	int	Id da marca para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/marcas/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Marca não encontrada"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de Produtos

A API de Produtos permite gerenciar produtos em um sistema. A API é baseada na arquitetura REST e aceita requisições nos formatos JSON e XML.

Listagem de produtos

Para listar todas os produtos, faça uma requisição GET para a URL base da API de Produtos:

GET base_url/produtos

Parâmetros

A API de Marcas suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_produto	int	ID do produto a ser retornado
cod_ant	int	Retorna em específico através do código antigo.
limite	int	Retorna um número específico.
inicio	int	Retorna a partir de um número específico.

Exemplo

GET /produtos?id_produto=1&&limite=10&inicio=0

Resposta

{
  "status": "OK",
  "produtos": [
    {
      "id_produto": 123,
      "nome": "Produto 1",
      "preco": 10.99,
      "estoque": 100
    },
    {
      "id_produto": 124,
      "nome": "Produto 2",
      "preco": 19.99,
      "estoque": 50
    }
  ]
}

Cadastrar produtos

Cria um novo produto no sistema. O corpo da requisição deve conter as seguintes informações:

POST /produtos

Parâmetros

A API de Produtos suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome do produto
preco	float	Preço do produto
estoque	int	Estoque do produto

Exemplo

POST /produtos HTTP/1.1
Host: exemplo.com
Content-Type: application/json

{
  "nome": "Produto 3",
  "preco": 15.99,
  "estoque": 200
}

Resposta

{
  "status": "OK",
  "id_produto": 125
}

Alteração de produto

Edita um produto existente.

PUT /produtos/{id}

Parâmetros

A API de Produtos suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
nome	string	Nome do produto
preco	float	Preço do produto
estoque	int	Estoque do produto

Exemplo

PUT /produtos/123 HTTP/1.1
Host: exemplo.com
Content-Type: application/json

{
  "preco": 12.99
}

Resposta

{
    "status": "OK"
}

Deletar produto

Deleta um produto.

DELETE /produtos/{id}

Parâmetros

A API de produto suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id	int	Id do produto para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/produtos/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Produto não encontrado"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de Pedidos

Esta API permite gerenciar pedidos de uma loja virtual.

Listagem de pedidos

Para listar todos os pedidos, faça uma requisição GET para a URL base da API de Pedidos:

GET base_url/pedidos

Parâmetros

A API de Pedidos suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_pedido	int	ID do pedido
datai	date	Data inicial do intervalo de busca
dataf	date	Data final do intervalo de busca
atualizado	int	Indica se a busca deve retornar apenas pedidos atualizados (sim/não)
cod_ant	int	Retorna em específico através do código antigo.
limite	int	Retorna um número específico.
inicio	int	Retorna a partir de um número específico.

Exemplo

GET /pedidos?id_pedido=1&&limite=10&inicio=0

Resposta

{
    "status": "OK",
    "pedidos": [
        {
            "id_pedido": 1,
            "data": "2022-03-26",
            "cod_cliente": 123,
            "valor_total": 100.0
        },
        {
            "id_pedido": 2,
            "data": "2022-03-27",
            "cod_cliente": 456,
            "valor_total": 200.0
        }
    ]
}

Cadastrar pedido

Cria um novo pedido no sistema. O corpo da requisição deve conter as seguintes informações:

POST /produtos

Parâmetros

A API de Pedidos suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
data	Date	Data do pedido
cod_cliente	int	Código do cliente que realizou o pedido
valor_total	float	Valor total do pedido

Exemplo

POST /pedidos HTTP/1.1
Content-Type: application/json

{
  "data": "27-03-2023",
  "cod_cliente": 15,
  "valor_total": 200.99
}

Resposta

{
  "status": "OK",
  "id_pedido": 15
}

Alteração de Pedido

Edita um Pedido existente.

PUT /Pedido/{id}

Parâmetros

A API de Pedido suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
data	Date	Data do pedido
cod_cliente	int	Código do cliente que realizou o pedido
valor_total	float	Valor total do pedido

Exemplo

PUT /pedidos/12 HTTP/1.1
Host: exemplo.com
Content-Type: application/json

{
  "valor_total": 212.99
}

Resposta

{
    "status": "OK"
}

Deletar pedido

Deleta um pedido.

DELETE /pedidos/{id}

Parâmetros

A API de Pedido suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id	int	Id do pedido para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/pedidos/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Pedido não encontrado"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}

Documentação da API de Pedidos Itens

Esta é a documentação da API Pedidos_itens, responsável por gerenciar os itens de pedidos.

Listagem de Pedidos Itens

Para listar todos os Pedidos Itens, faça uma requisição GET para a URL base da API de Pedidos:

GET base_url/pedidos_itens

Parâmetros

A API de Pedidos Itens suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_pedido	int	ID do pedido
cod_ant	int	Retorna em específico através do código antigo.
limite	int	Retorna um número específico.
inicio	int	Retorna a partir de um número específico.

Exemplo

GET /pedidos_itens?id_pedido=1&&limite=10&inicio=0

Resposta

{
  "status": "OK",
  "itens": [
    {
      "id": 1,
      "descricao": "Produto 1",
      "quantidade": 2,
      "preco_unitario": 10.5,
      "preco_total": 21
    },
    {
      "id": 2,
      "descricao": "Produto 2",
      "quantidade": 3,
      "preco_unitario": 8,
      "preco_total": 24
    }
  ]
}

Cadastrar um novo item de pedido

Cadastra um novo item de pedido.

POST /pedidos_itens

Parâmetros

A API de Pedidos itens suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id_pedido	int	O ID do pedido ao qual o item pertence.
descricao	string	A descrição do produto.
quantidade	int	A quantidade do produto.
preco_unitario	float	O preço unitário do produto.
preco_total	float	O preço total do produto.

Exemplo

POST /pedidos_itens HTTP/1.1
Content-Type: application/json

{
  "id_pedido": 12,
  "descricao": "Produto 1",
  "quantidade": 2,
  "preco_unitario": 15.00,
  "preco_total": 30.00,
}

Resposta

{
  "status": "OK",
  "id_pedido_item": 1
}

Editar um item de pedido

Edita um item de pedido existente.

PUT /pedidos_itens/{id}

Parâmetros

A API de Pedidos itens suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
descricao	string	A descrição do produto.
quantidade	int	A quantidade do produto.
preco_unitario	float	O preço unitário do produto.
preco_total	float	O preço total do produto.

Exemplo

PUT /pedidos_itens/12 HTTP/1.1
Host: exemplo.com
Content-Type: application/json

{
  "quantidade": 2
}

Resposta

{
    "status": "OK"
}

Deletar pedido itens

Deleta um item do pedido.

DELETE /pedidos_itens/{id}

Parâmetros

A API de Pedidos itens suporta os seguintes parâmetros:

Parâmetro	Tipo	Descrição
id	int	Id do item do pedido para deletar

Exemplo

curl -X DELETE "http://localhost/api/v1/pedidos_itens/1"

Resposta 200

{
    "status": "OK"
}

Resposta 404

{
    "status": "ERRO",
    "erro": "Item não encontrada"
}

Resposta 500

{
    "status": "ERRO",
    "erro": "Mensagem de erro"
}