Documentação da API

Esta documentação descreve os endpoints disponíveis na API RESTful do Google Local Ads Feed.

Autenticação

A API utiliza autenticação JWT (JSON Web Token). Para acessar os endpoints protegidos, você precisa obter um token de acesso.

POST /api/auth/login
Descrição

Autentica um usuário e retorna um token JWT.

Parâmetros
Nome Tipo Descrição Obrigatório
email string E-mail do usuário Sim
password string Senha do usuário Sim
Exemplo de Requisição
{
  "email": "[email protected]",
  "password": "senha123"
}
Exemplo de Resposta
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "token_type": "bearer",
  "expires_in": 3600
}
POST /api/auth/register
Descrição

Registra um novo usuário e retorna um token JWT.

Parâmetros
Nome Tipo Descrição Obrigatório
name string Nome do usuário Sim
email string E-mail do usuário Sim
password string Senha do usuário (mínimo 8 caracteres) Sim
password_confirmation string Confirmação da senha Sim

Lojas

Endpoints para gerenciar lojas.

GET /api/stores
Descrição

Retorna uma lista paginada de lojas do usuário autenticado.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
Parâmetros de Query
Nome Tipo Descrição Obrigatório
page integer Número da página Não
per_page integer Itens por página Não
POST /api/stores
Descrição

Cria uma nova loja para o usuário autenticado.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
Content-Type application/json Tipo de conteúdo da requisição
Parâmetros
Nome Tipo Descrição Obrigatório
store_code string Código único da loja Sim
venue_name string Nome da loja Sim
address_line_1 string Endereço (linha 1) Sim
address_line_2 string Endereço (linha 2) Não
city string Cidade Sim
state string Estado Sim
postal_code string CEP Sim
country string País Sim
phone string Telefone Não
email string E-mail Não
latitude float Latitude Não
longitude float Longitude Não

Produtos

Endpoints para gerenciar produtos.

GET /api/products
Descrição

Retorna uma lista paginada de produtos do usuário autenticado.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
Parâmetros de Query
Nome Tipo Descrição Obrigatório
store_code string Filtrar por código da loja Não
page integer Número da página Não
per_page integer Itens por página Não
POST /api/products
Descrição

Cria um novo produto para uma loja específica.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
Content-Type application/json Tipo de conteúdo da requisição
Parâmetros
Nome Tipo Descrição Obrigatório
sku string SKU do produto Sim
store_code string Código da loja Sim
title string Título do produto Sim
description string Descrição do produto Não
gtin string GTIN (código de barras) Não
mpn string MPN (código do fabricante) Não
brand string Marca do produto Não
google_product_category string Categoria do Google Não
product_type string Tipo de produto Não
link string URL do produto Não
image_link string URL da imagem Não
condition string Condição (new, used, refurbished) Não
availability string Disponibilidade (in stock, out of stock, preorder) Não
price numeric Preço Sim
sale_price numeric Preço promocional Não
price_currency string Moeda (ex: BRL) Não
quantity integer Quantidade em estoque Não
pickup_method string Método de retirada (buy, ship to store, pickup) Não
pickup_sla string Prazo de retirada (same day, next day, 2-day, 3-day, 1-week) Não
PUT /api/products/{id}
Descrição

Atualiza um produto existente.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
Content-Type application/json Tipo de conteúdo da requisição
Parâmetros
Nome Tipo Descrição Obrigatório
title string Título do produto Sim
description string Descrição do produto Não
gtin string GTIN (código de barras) Não
mpn string MPN (código do fabricante) Não
brand string Marca do produto Não
google_product_category string Categoria do Google Não
product_type string Tipo de produto Não
link string URL do produto Não
image_link string URL da imagem Não
condition string Condição (new, used, refurbished) Não
availability string Disponibilidade (in stock, out of stock, preorder) Não
price numeric Preço Sim
sale_price numeric Preço promocional Não
price_currency string Moeda (ex: BRL) Não
quantity integer Quantidade em estoque Não
pickup_method string Método de retirada (buy, ship to store, pickup) Não
pickup_sla string Prazo de retirada (same day, next day, 2-day, 3-day, 1-week) Não

Feeds XML

Endpoints para gerenciar URLs de feed XML.

GET /api/feed-urls
Descrição

Retorna uma lista paginada de URLs de feed do usuário autenticado.

Headers
Nome Valor Descrição
Authorization Bearer {token} Token JWT obtido na autenticação
GET /local_inventory/{storeCode}/feed.xml
Descrição

Gera o feed XML para uma loja específica.

Parâmetros de Path
Nome Tipo Descrição Obrigatório
storeCode string Código da loja Sim
Parâmetros de Query
Nome Tipo Descrição Obrigatório
token string Token de acesso ao feed Sim