README.md

Client-API-GTIN

OSCBR - Open Source Community Brasil

Site: https://gtin.rscsistemas.com.br

Para fazer uso da API GTIN precisará de um usuário e senha, caso ainda não tenha feito poderá esta fazendo seu cadastro acesssando o link abaixo:

Cadastre-se: https://gtin.rscsistemas.com.br/cadastro

Documentação API GTIN V1.0.1

A seguir poderá encontrar todo o passo a passo para fezer uso de nossa api.

Obter token Bearer

O Token gerado será necessário para consumir os endpoints da API GTIN.

1. O tempo de vida de um token gerado é de uma hora. Com isso, é possível realizar um número determinado de requisições nas apis, de acordo com o rate limit de cada api, utilizando um único token.

2. Rate limit: 20 chamadas por minuto para o plano free, que esta em vigor atualmente.

/oauth/token

Endpoint de solicitação do token Bearer de acesso.

URL: https://gtin.rscsistemas.com.br/oauth/token

Paramêtros

username

Requerido

string (header)

password

Requerido

string (header)

Respostas

Código 200:

A requisição foi processada com sucesso.

Token Gerado

Media type: application/json

{"token":"eyJhbGciOiAiQUVTMjU2IiwgInR5cCI6ICJKV1QifQ==.eyJpc3MiOiJTMkFURnE4OGdtVEsiLCAiZXhwIjoiMTY4MzUyODg0NiIsICJpYXQiOiIxNjgzNTI4NjY2IiwgInNlY3JldHMiOiJleUp6WldOeVpYUnpJam9pWlhsS2NGcERTVFpKYWtVMVNXbDNaMGx1VGpCWldGSXhZM2xKTmtscVJXbE1RMEZwWkVkc2QySXhPVEZqTTFab1kyMXNka2xxYjJsTlUwbzVJaXdnSW0xa05TSTZJakl3UVRjNU5UQXdNREF3TURBd01EQkdORVl3TVVJd01UWXdNVU5DTURBeUluMD0ifQ==.fLS55zjO9i0/rrjSYiYZbZyB64HGawU53QG9szrF5tT4TpJi6O8Md8sCBiwx9u90CR8mSmo37ovGeZ29vJMrKxtHgSBdI1kI/f+dYAhQ/60DitS9fGN3qIynL+OByhAk6UL1TQTTO2+48wa1ioLtwA+Un1lWDFW0MON55C0a1+z9ZH1Yya8FnoZUk3fMx5Syt4z5ZbeNQVwWrBcS2LGXd8OaDHeTRF70RaNTMW09vRoqgsEWyIOEXs0ZLtPkj70Mzc1QAGfpZ/KSsFIVOovuvf5gu9kV4+b6tVMDyIwn3WEcdEUM39DhPZ3UueQn48mcYASXEs9CZtxjXtcfuXehHike/ULaW2qvuYM7iVDcAPwBuH57LX44zj90oo4JTI1LzkAiedIE61mTS0GYQexl8uWEbD25Hv2smWynuMKt1QxRKBdOdc5abnV0vMu0DJv7go42twLfYSb1u4baZg7vuKCyLrAt"}

Código 401:

Não autenticado

Os dados de autenticação estão incorretos. Verifique no cabeçalho (header) da requisição.

Obter Informaçãoes do produto

Com o Token gerado anteriormente agora você pode fazer chamada a api usando o mesmo token até que o mesmo se expire.

/api/gtin/infor/:gtin

Endpoint de solicitação das informações de um determinado produto atravez do seu EAN/GTIN.

URL: https://gtin.rscsistemas.com.br/api/gtin/infor/:gtin

Paramêtros

gtin

Requerido

string (query)

Respostas

Código 200:

A requisição foi processada com sucesso.

Retorno header:

Media type: application/json

{
    "ean": "7896116900029",
    "ean_tipo": "EAN13",
    "cest": "",
    "ncm": 7133399,
    "nome": "FEIJAO CARIOCA KICALDO T1 1KG",
    "nome_acento": "FEIJÃO CARIOCA TIPO 1 KICALDO PACOTE 1KG",
    "unid_abr": "KG",
    "unid_desc": "QUILOGRAMA",
    "marca": "KICALDO",
    "pais": "BRASIL",
    "categoria": "Carioca",
    "dh_update": "16/05/2023 22:06:29",
    "link_foto": "https://gtin.rscsistemas.com.br/api/gtin/img/7896116900029"
}

Código 405:

Não encontrado

O produto para qual solicitou informaçãoes não foi encontrado em nossas bases de dados.

Retorno header:

Media type: application/json

{
    "ean": "405",
    "ean_tipo": "405",
    "cest": "405",
    "ncm": 405,
    "nome": "405",
    "nome_acento": "405",
    "unid_abr": "405",
    "unid_desc": "405",
    "marca": "405",
    "pais": "405",
    "categoria": "405",
    "dh_update": "405",
    "link_foto": "405"
}

Obter Imagem do produto

Com o Token gerado anteriormente agora você pode fazer chamada a api usando o mesmo token até que o mesmo se expire.

/api/gtin/img/:gtin

Endpoint de solicitação a imagem do produto

URL: https://gtin.rscsistemas.com.br/api/gtin/img/:gtin

Paramêtros

gtin

Requerido

string (query)

Respostas

Código 200:

A requisição foi processada com sucesso.

Retorno body:

Media type: image/x-png

Código 400:

Requisição mal formada

A requisição não está de acordo com o formato esperado. Verifique se realmente passou o EAN/GTIN na url da requisição.

Código 404:

Não encontrado

O produto para qual solicitou a imgagem não foi encontrado em nossas bases de dados.

Retorno body:

Media type: image/x-png

Código 204:

Sem conteúdo

Não foi encontrado uma imagem para o produto informado.

Retorno body:

Media type: image/x-png