SkyHub API

categories

Categorias de produtos

A maioria dos e-commerces possuem uma estrutura em árvore que define uma hierarquia no cadastro das categorias. Exemplo, a categoria "carregador" pode ser uma (sub)categoria filha da categoria "celular". Para simular essa hieraquia, o nome da categoria na skyhub deve ser a junção de todos os nomes das categorias da hierarquia separados por um ">".

Exemplo:

eletrónicos > celulares > carregadores eletrónicos > celulares > fone de ouvido

categories Overview

{
  "category": {
  "category": { ... }
Object

Dados da categoria

    "code": "category001",
String

Código interno de identificação da categoria

    "name": "eletrónicos > celulares > fone de ouvido"
String

Nome da categoria. O nome da categoria na skyhub deve ser a junção de todos os nomes das categorias da hierarquia separados por um ">". Exemplo, "Calçados > Feminino > Sapatilhas"

  }
}

Listar categorias

Open in API Explorer
GET /categories

Listar categorias cadastradas na SkyHub

Example Request

Format:
curl --request GET \
  --url https://desenvolvedores.skyhub.com.br/categories \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-accountmanager-key: foo' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-user-email: MUDAR@SEU_EMAIL.COM'
require 'uri'
require 'net/http'

url = URI("https://desenvolvedores.skyhub.com.br/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["x-api-key"] = 'YOUR API KEY HERE'
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["x-user-email"] = 'MUDAR@SEU_EMAIL.COM'
request["x-accountmanager-key"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "desenvolvedores.skyhub.com.br",
  "port": null,
  "path": "/categories",
  "headers": {
    "x-api-key": "YOUR API KEY HERE",
    "accept": "application/json",
    "content-type": "application/json",
    "x-user-email": "MUDAR@SEU_EMAIL.COM",
    "x-accountmanager-key": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("desenvolvedores.skyhub.com.br")

headers = {
    'x-api-key': "YOUR API KEY HERE",
    'accept': "application/json",
    'content-type': "application/json",
    'x-user-email': "MUDAR@SEU_EMAIL.COM",
    'x-accountmanager-key': "foo"
    }

conn.request("GET", "/categories", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://desenvolvedores.skyhub.com.br/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: application/json",
    "x-accountmanager-key: foo",
    "x-api-key: YOUR API KEY HERE",
    "x-user-email: MUDAR@SEU_EMAIL.COM"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://desenvolvedores.skyhub.com.br/categories"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-user-email", "MUDAR@SEU_EMAIL.COM")
	req.Header.Add("x-accountmanager-key", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
Accept String Required application/json
Content-Type String Required application/json
X-User-Email String Required MUDAR@SEU_EMAIL.COM
x-accountmanager-key String Required

Identificador da sua integração com a SkyHub

foo

Responses

200 Success

Categorias cadastradas

categories Categories
[
  "code": "category001",
String

Código interno de identificação da categoria

  "name": "eletrónicos > celulares > fone de ouvido"
String

Nome da categoria. O nome da categoria na skyhub deve ser a junção de todos os nomes das categorias da hierarquia separados por um ">". Exemplo, "Calçados > Feminino > Sapatilhas"

]
401 Authentication Failed

Não foi possível realizar a autenticação. Verifique se as credenciais de acesso estão corretas.

categories Authfailed
{
  "error": "Para continuar, efetue login."
String
}

Criar categoria

Open in API Explorer
POST /categories

Criar uma nova categoria

Example Request

Format:
curl --request POST \
  --url https://desenvolvedores.skyhub.com.br/categories \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-accountmanager-key: foo' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-user-email: MUDAR@SEU_EMAIL.COM' \
  --data '{"category":{"code":"category001","name":"eletrónicos > celulares > fone de ouvido"}}'
require 'uri'
require 'net/http'

url = URI("https://desenvolvedores.skyhub.com.br/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["x-api-key"] = 'YOUR API KEY HERE'
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["x-user-email"] = 'MUDAR@SEU_EMAIL.COM'
request["x-accountmanager-key"] = 'foo'
request.body = "{\"category\":{\"code\":\"category001\",\"name\":\"eletrónicos > celulares > fone de ouvido\"}}"

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "POST",
  "hostname": "desenvolvedores.skyhub.com.br",
  "port": null,
  "path": "/categories",
  "headers": {
    "x-api-key": "YOUR API KEY HERE",
    "accept": "application/json",
    "content-type": "application/json",
    "x-user-email": "MUDAR@SEU_EMAIL.COM",
    "x-accountmanager-key": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ category: 
   { code: 'category001',
     name: 'eletrónicos > celulares > fone de ouvido' } }));
req.end();
import http.client

conn = http.client.HTTPSConnection("desenvolvedores.skyhub.com.br")

payload = "{\"category\":{\"code\":\"category001\",\"name\":\"eletrónicos > celulares > fone de ouvido\"}}"

headers = {
    'x-api-key': "YOUR API KEY HERE",
    'accept': "application/json",
    'content-type': "application/json",
    'x-user-email': "MUDAR@SEU_EMAIL.COM",
    'x-accountmanager-key': "foo"
    }

conn.request("POST", "/categories", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://desenvolvedores.skyhub.com.br/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"category\":{\"code\":\"category001\",\"name\":\"eletrónicos > celulares > fone de ouvido\"}}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: application/json",
    "x-accountmanager-key: foo",
    "x-api-key: YOUR API KEY HERE",
    "x-user-email: MUDAR@SEU_EMAIL.COM"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://desenvolvedores.skyhub.com.br/categories"

	payload := strings.NewReader("{\"category\":{\"code\":\"category001\",\"name\":\"eletrónicos > celulares > fone de ouvido\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-user-email", "MUDAR@SEU_EMAIL.COM")
	req.Header.Add("x-accountmanager-key", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Body

Name Type Required Description Example
body Object Required

Dados da categoria a ser criada

{
  "category": {
  "category": { ... }
Object

Dados da categoria

    "code": "category001",
String

Código interno de identificação da categoria

    "name": "eletrónicos > celulares > fone de ouvido"
String

Nome da categoria. O nome da categoria na skyhub deve ser a junção de todos os nomes das categorias da hierarquia separados por um ">". Exemplo, "Calçados > Feminino > Sapatilhas"

  }
}

Request Headers

Name Type Required Description Example
Accept String Required application/json
Content-Type String Required application/json
X-User-Email String Required MUDAR@SEU_EMAIL.COM
x-accountmanager-key String Required

Identificador da sua integração com a SkyHub

foo

Responses

204 Success

Categoria criada com sucesso

(Empty Response)
401 Authentication Failed

Não foi possível realizar a autenticação. Verifique se as credenciais de acesso estão corretas.

categories Authfailed
{
  "error": "Para continuar, efetue login."
String
}

Atualizar categoria

Open in API Explorer
PUT /categories/{code}

Atualizar uma categoria criada anteriormente

Example Request

Format:
curl --request PUT \
  --url https://desenvolvedores.skyhub.com.br/categories/category001 \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-accountmanager-key: foo' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-user-email: MUDAR@SEU_EMAIL.COM' \
  --data '{"category":{"name":"eletrónicos > celulares > fone de ouvido"}}'
require 'uri'
require 'net/http'

url = URI("https://desenvolvedores.skyhub.com.br/categories/category001")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["x-api-key"] = 'YOUR API KEY HERE'
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["x-user-email"] = 'MUDAR@SEU_EMAIL.COM'
request["x-accountmanager-key"] = 'foo'
request.body = "{\"category\":{\"name\":\"eletrónicos > celulares > fone de ouvido\"}}"

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "desenvolvedores.skyhub.com.br",
  "port": null,
  "path": "/categories/category001",
  "headers": {
    "x-api-key": "YOUR API KEY HERE",
    "accept": "application/json",
    "content-type": "application/json",
    "x-user-email": "MUDAR@SEU_EMAIL.COM",
    "x-accountmanager-key": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ category: { name: 'eletrónicos > celulares > fone de ouvido' } }));
req.end();
import http.client

conn = http.client.HTTPSConnection("desenvolvedores.skyhub.com.br")

payload = "{\"category\":{\"name\":\"eletrónicos > celulares > fone de ouvido\"}}"

headers = {
    'x-api-key': "YOUR API KEY HERE",
    'accept': "application/json",
    'content-type': "application/json",
    'x-user-email': "MUDAR@SEU_EMAIL.COM",
    'x-accountmanager-key': "foo"
    }

conn.request("PUT", "/categories/category001", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://desenvolvedores.skyhub.com.br/categories/category001",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"category\":{\"name\":\"eletrónicos > celulares > fone de ouvido\"}}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: application/json",
    "x-accountmanager-key: foo",
    "x-api-key: YOUR API KEY HERE",
    "x-user-email: MUDAR@SEU_EMAIL.COM"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://desenvolvedores.skyhub.com.br/categories/category001"

	payload := strings.NewReader("{\"category\":{\"name\":\"eletrónicos > celulares > fone de ouvido\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-user-email", "MUDAR@SEU_EMAIL.COM")
	req.Header.Add("x-accountmanager-key", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Path Parameters

Name Type Required Description Example
code String Required

Código da categoria a ser atualizada

category001

Request Body

Name Type Required Description Example
body Object Required

Dados da categoria para atualização

{
  "category": {
  "category": { ... }
Object

Dados da categoria para atualização

    "name": "eletrónicos > celulares > fone de ouvido"
String

Nome da categoria. O nome da categoria na skyhub deve ser a junção de todos os nomes das categorias da hierarquia separados por um ">". Exemplo, "Calçados > Feminino > Sapatilhas"

  }
}

Request Headers

Name Type Required Description Example
Accept String Required application/json
Content-Type String Required application/json
X-User-Email String Required MUDAR@SEU_EMAIL.COM
x-accountmanager-key String Required

Identificador da sua integração com a SkyHub

foo

Responses

204 Success

Categoria atualizada com sucesso

(Empty Response)
401 Authentication Failed

Não foi possível realizar a autenticação. Verifique se as credenciais de acesso estão corretas.

categories Authfailed
{
  "error": "Para continuar, efetue login."
String
}
404 CategoryNotFound

Categoria não encontrada

categories Categorynotfound
{
  "error": "Não foi possível encontrar Category: foo"
String

Categoria não encontrada

}

Remover categoria

Open in API Explorer
DELETE /categories/{code}

Remover categoria com o código especificado

Example Request

Format:
curl --request DELETE \
  --url https://desenvolvedores.skyhub.com.br/categories/category001 \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-accountmanager-key: foo' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-user-email: MUDAR@SEU_EMAIL.COM'
require 'uri'
require 'net/http'

url = URI("https://desenvolvedores.skyhub.com.br/categories/category001")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = 'YOUR API KEY HERE'
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["x-user-email"] = 'MUDAR@SEU_EMAIL.COM'
request["x-accountmanager-key"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "desenvolvedores.skyhub.com.br",
  "port": null,
  "path": "/categories/category001",
  "headers": {
    "x-api-key": "YOUR API KEY HERE",
    "accept": "application/json",
    "content-type": "application/json",
    "x-user-email": "MUDAR@SEU_EMAIL.COM",
    "x-accountmanager-key": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("desenvolvedores.skyhub.com.br")

headers = {
    'x-api-key': "YOUR API KEY HERE",
    'accept': "application/json",
    'content-type': "application/json",
    'x-user-email': "MUDAR@SEU_EMAIL.COM",
    'x-accountmanager-key': "foo"
    }

conn.request("DELETE", "/categories/category001", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://desenvolvedores.skyhub.com.br/categories/category001",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: application/json",
    "x-accountmanager-key: foo",
    "x-api-key: YOUR API KEY HERE",
    "x-user-email: MUDAR@SEU_EMAIL.COM"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://desenvolvedores.skyhub.com.br/categories/category001"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-user-email", "MUDAR@SEU_EMAIL.COM")
	req.Header.Add("x-accountmanager-key", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Path Parameters

Name Type Required Description Example
code String Required

Código da categoria a ser removida

category001

Request Headers

Name Type Required Description Example
Accept String Required application/json
Content-Type String Required application/json
X-User-Email String Required MUDAR@SEU_EMAIL.COM
x-accountmanager-key String Required

Identificador da sua integração com a SkyHub

foo

Responses

204 Success

Categoria removida com sucesso

(Empty Response)
401 Authentication Failed

Não foi possível realizar a autenticação. Verifique se as credenciais de acesso estão corretas.

categories Authfailed
{
  "error": "Para continuar, efetue login."
String
}
404 NotFound

Categoria não encontrada

categories Categorynotfound
{
  "error": "Não foi possível encontrar Category: foo"
String

Categoria não encontrada

}