Buscame API

Api que irá realizar o processamento e busca de produtos utilizando Kotlin e IA

Tópicos

• Sobre
  • Introdução
  • Autores
  • Instalação
• Objetivos
• Rotas

Sobre

Introdução

A API de busca irá permitir buscar produtos por texto ou imagem utilizando os serviços em nuvem do IBM Watson e da plataforma em nuvem da Google. Os serviços utizados foram:

• Para a pesquisa por produtos: Custom Search API
• Para a análise de imagens: Visual Recognition
• Para a tradução dos termos: Language Translator

Autores

Gabriel Lima

Jonas Santos

Melinne Diniz

Sarah Júlia

Instalação

Obs: Em ambiente de desenvolvimento

• Clonar o projeto git clone https://github.com/gabrielSantosLima/buscame-api
• Criar credenciais em todos os serviços utilizados na API
• Custom Search API
• Visual Recognition e Language Translator
• Criar arquivo no diretório src/main/resources/credentials.properties com a seguinte estrutura:

#Visual Recognitions
VG_APIKEY=<CHAVE_DA_API>

#Custom Search API
CS_APIKEY=<CHAVE_DA_API>
CS_CONTEXTKEY=254b1bad154db7c85 # chave para teste do contexto de busca do robô de busca

#Language Translate
LT_APIKEY=<CHAVE_DA_API>

#Services URL
VG_URL=https://api.us-south.visual-recognition.watson.cloud.ibm.com
LT_URL=https://api.us-south.language-translator.watson.cloud.ibm.com
CS_URL=https://www.googleapis.com/customsearch/v1

• Executar projeto

Funcionalidades

• Pesquisar produtos por imagem
• Pesquisar produtos por texto
• Aplicar alguns filtros de busca
  • Por preço
  • Por site
  • Por marca
• Busca paginada

Rotas

POST

• /api/search/text?text=<TERMO_DE_BUSCA>: busca por texto.
• /api/search/image-analyse: analisar uma imagem passando esta imagem do tipo ByteArray no corpo da requisição.
• /api/search/image: busca por imagem passando esta imagem do tipo ByteArray no corpo da requisição.

Parâmetros (busca por texto e imagem)

• brandName: filtro de marca.
• url: filtro de url de site.
• price: filtro de preço.
• page: número da página de busca.

Exemplo de Resultado (pesquisa por texto e imagem )

[
{
  "id": "30337640",
  "term": "gato ",
  "title": "Moletom 284 Gato | Netshoes",
  "price": 229.99,
  "description": "Moletom 284 Gato | Netshoes",
  "url": "https://www.netshoes.com.br/moletom-284-gato-off+white-E97-0265-205",
  "image": "https://static.netshoes.com.br/produtos/moletom-284-gato/05/E97-0265-205/E97-0265-205_zoom1.jpg?ims=544x"
}
]

Exemplo de Resultado (analisar imagem)

[
  "cat",
  "feline",
  "carnivore",
  "mammal",
  "animal",
  "tabby cat",
  "domestic cat",
  "wildcat",
  "ash grey color"
]