Inicio
API Endpoint
https://api.{domain}.com.br/
Esse manual técnico tem como objetivo ajudar desenvolvedores/programadores na integração com a API Rest GoUx.
A API GoUx é uma integração do tipo REST que realiza comunicações seguras com lojas virtuais credenciadas a esta integração através de objetos JSON, que tenham ID e Token válidos.
A REST API pode ter seus recursos acessados e utilizados por qualquer linguagem de programação que tenha recursos Web de comunicação HTTP e manipulação de JSON.
Para obter suporte relacionado a API, entre em contato com tiagobrilhante@goux.com.br.
Autenticação
curl --location
--request POST 'http://api.{domain}.com.br/auth/login?username={user}&password={pass}' \
--header 'Content-Type: application/json' \
--header 'Client-Service: frontend-client' \
--header 'Auth-Key: simplerestapi' \
Response:
{
"status": 200,
"message": "Login realizado com sucesso.",
"id": "1",
"token": "399a441ab120facf5a188b48c3c5c0fa48252a85df3934c2ce55f0c37c08f6..."
}
Para realizar a autenticação, envie para o endpoint os parâmetros username e password.
POST: 'http://api.{domain}.com.br/auth/login?username={user}&password={pass}'
Parâmetros
| Chave |
Valor |
Descrição |
| username |
api_user |
Seu usuário administrativo na plataforma |
| password |
123456 |
Senha de acesso do usuário administrativo |
Header
| Chave |
Valor |
Descrição |
| Content-Type |
application/json |
|
| Client-Service |
frontend-client |
|
| Auth-Key |
simplerestapi |
|
Categorias
# Here is a curl example
curl \
request GET 'https://api.{domain}.com.br/categories/' \
--header 'Content-Type: application/json' \
--header 'Client-Service: frontend-client' \
--header 'Auth-Key: simplerestapi' \
--header 'User-ID: 4' \
--header 'Authorization: feae050d4db4fbcbbe...' \
Use o endpoint abaixo para listar as categorias da loja
GET: https://api.{domain}.com.br/categories/
Result example :
[
{
"id": "1",
"name": "Blusas"
},
{
"id": "2",
"name": "Calçados"
}
]
Header
| Chave |
Valor |
Descrição |
| Content-Type |
application/json |
|
| Client-Service |
frontend-client |
|
| Auth-Key |
simplerestapi |
|
| User-ID |
4 |
ID do usuário |
| Authorization |
399a441ab120f... |
Token de acesso |
Produtos
# Here is a curl example
curl \
request GET 'https://api.{domain}.com.br/products/' \
--header 'Content-Type: application/json' \
--header 'Client-Service: frontend-client' \
--header 'Auth-Key: simplerestapi' \
--header 'User-ID: 4' \
--header 'Authorization: feae050d4db4fbcbbe...' \
Use o endpoint abaixo para listar os produtos da loja
API retorna 20 registros por requisição.
GET: https://api.{domain}.com.br/products/
Result example :
{
"0": {
"id": "82",
"slug": "teste-pagamento-82",
"sku": "",
"title": "Teste Pagamento",
"description": "",
"seo_title": "",
"seo_description": "",
"seo_keywords": "",
"gtin": null,
"mpn": null,
"ncm": null,
"brand": "0",
"category_id": "17",
"price": "2500",
"cost": null,
"discount_rate": "0",
"status": "1",
"stock": "10",
"shipping_cost_type": "free_shipping",
"height": "0",
"width": "0",
"length": "0",
"weight": "1",
"cubage": "0",
"created_at": "2021-03-21 23:17:55"
},
"1": {
"id": "105",
"slug": "kit-cravinhos-nunca-ouvi-falar-105",
"sku": "SKU-GP962P1X8",
"title": "KIT - CRAVINHOS? NUNCA OUVI FALAR!",
"description": "Descrição do produto",
"seo_title": "KIT - CRAVINHOS? NUNCA OUVI FALAR!",
"seo_description": "Cravos são acúmulo de sebo, sujidades, poluição, queratina, resquício de maquiagem e protetor solar..",
"seo_keywords": "",
"gtin": null,
"mpn": null,
"ncm": null,
"brand": "0",
"category_id": "39",
"price": "10090",
"cost": "0",
"discount_rate": "0",
"status": "1",
"stock": "1",
"shipping_cost_type": "Correios",
"height": "19",
"width": "7",
"length": "12",
"weight": "0.350",
"cubage": "0",
"created_at": "2021-06-30 19:09:16",
"variations": [
{
"id": "17",
"product_id": "105",
"user_id": "1",
"parent_id": "0",
"label_names": [
{
"lang_id": "2",
"label": "PELE"
}
],
"variation_type": "radio_button",
"insert_type": "new",
"option_display_type": "text",
"show_images_on_slider": "0",
"use_different_price": "0",
"is_visible": "1",
"options": [
{
"id": "34",
"variation_id": "17",
"parent_id": "0",
"option_names": [
{
"lang_id": "2",
"option_name": "OLEOSA E ACNEICA"
}
],
"stock": "0",
"color": "",
"price": "0",
"discount_rate": "0",
"is_default": "0",
"use_default_price": "0",
"no_discount": "0"
},
{
"id": "35",
"variation_id": "17",
"parent_id": "0",
"option_names": [
{
"lang_id": "2",
"option_name": "NORMAL E SECA"
}
],
"stock": "0",
"color": "",
"price": "0",
"discount_rate": "0",
"is_default": "0",
"use_default_price": "0",
"no_discount": "0"
}
]
}
]
},
Header
| Chave |
Valor |
Descrição |
| Content-Type |
application/json |
|
| Client-Service |
frontend-client |
|
| Auth-Key |
simplerestapi |
|
| User-ID |
4 |
ID do usuário |
| Authorization |
399a441ab120f... |
Token de acesso |
Paramêtros
| Parâmetro |
Valor |
Descrição |
| page |
1 |
Envie o parâmetro "page" com o número da página |
Atualizar preço e estoque produto simples (sem variação)
# Here is a curl example
curl \
--request PUT 'https://api.{domain}.com.br/products/update/{id}' \
--header 'Content-Type: application/json' \
--header 'Client-Service: frontend-client' \
--header 'Auth-Key: simplerestapi' \
--header 'User-ID: 4' \
--header 'Authorization: feae050d....' \
--data-raw '{
"stock":"99",
"price":"2500"
}'
Atualize o preço e estoque do produto, O Valor deve ser enviado em centavos.
PUT:{domain}/api/products/update/{id}
Form data :
{
"stock":"99",
"price":"2500"
}
Result example :
{
"status": 200,
"message": "Produto atualizado com sucesso."
}
Campos
| Campo |
Tipo |
Descrição |
| stock |
number |
Informe o estoque do produto |
| price |
number |
Envie o valor do produto em centavos |
Header
| Chave |
Valor |
Descrição |
| Content-Type |
application/json |
|
| Client-Service |
frontend-client |
|
| Auth-Key |
simplerestapi |
|
| User-ID |
4 |
ID do usuário |
| Authorization |
399a441ab120f... |
Token de acesso |
Atualizar preço e estoque de uma variação
# Here is a curl example
curl \
--request PUT 'https://api.{domain}.com.br/products/variation/{id}' \
--header 'Content-Type: application/json' \
--header 'Client-Service: frontend-client' \
--header 'Auth-Key: simplerestapi' \
--header 'User-ID: 4' \
--header 'Authorization: feae050d....' \
--data-raw '{
"stock":"99",
"price":"2500"
}'
Atualize o preço e estoque de uma variação, O Valor deve ser enviado em centavos.
PUT:{domain}/api/products/variation/{id}
Form data :
{
"stock":"99",
"price":"2500"
}
Result example :
{
"status": 200,
"message": "Produto atualizado com sucesso."
}
Campos
| Campo |
Tipo |
Descrição |
| stock |
number |
Informe o estoque da variação |
| price |
number |
Envie o valor da variação em centavos |
Header
| Chave |
Valor |
Descrição |
| Content-Type |
application/json |
|
| Client-Service |
frontend-client |
|
| Auth-Key |
simplerestapi |
|
| User-ID |
4 |
ID do usuário |
| Authorization |
399a441ab120f... |
Token de acesso |
Errors
The Westeros API uses the following error codes:
| Error Code |
Meaning |
| X000 |
Some parameters are missing. This error appears when you don't pass every mandatory parameters.
|
| X001 |
Unknown or unvalid secret_key. This error appears if you use an unknow API key or if your API key expired.
|
| X002 |
Unvalid secret_key for this domain. This error appears if you use an API key non specified for your domain. Developper or Universal API keys doesn't have domain checker.
|
| X003 |
Unknown or unvalid user token. This error appears if you use an unknow user token or if the user token expired.
|
