API - Sistema de Gestão Online

Bem-Vindo a nossa Documentação


Esta documentação mostrará como usar os vários recursos provenientes da API do Sistema Gestão Online, quais são os requisitos para usar esses recursos e alguns exemplos nas linguagens de programação mais usadas.

Na seção de introdução, apresentamos como obter a chave de acesso necessária para fazer as requisições, bem como usá-la.

Nas seções a seguir, mostramos os recursos disponíveis em nossa API, demonstrando como você pode testá-los usando o Postman e como implementar as solicitações em determinadas linguagens de programação.

Nosso endpoint para todas as requisições:

https://www.sistemagestaoonline.com.br/sistema/rest

Versão atual: v0.2.1

Início

Introdução

Nossas API utilizam o protocolo REST para receber as requisições, utilizando o modelo HTTP cujo método disponível é apenas o POST. Para solicitações que desejam receber dados do sistema, nossa API usa o formato JSON para recuperar os dados.

Autenticação

Para acessar os recursos da API, o usuário deve ter uma Chave. Essa chave pode ser adquirida facilmente entrando em contato com nossa equipe. Para isso, mande um email para suporte@softup.com.br com o assunto "Integração API" e no corpo do email seu login de usuário na plataforma.

Estoque

Consultar Estoque

Este método é utilizado para obter o estoque atual de determinado produto ou variação, através do seu SKU.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoReferencia Character(12) Código SKU ou Referência do Produto
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg93=gb",
"ProdutoReferencia": "123"
}





Então faça a requisição abaixo:

POST

/api_sgo.wsconsultaestoque

Resposta:
{
"EstoqueAtual": "123"
}




ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo o erro ocorrido.

{
"error":{
"code":"500",
"message":"Error"
}
}

Pessoas

Consultar Pessoas

Este método permite consultar as informações de uma determinada pessoa, através de seu CPF ou CNPJ.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
OrderReg Character(18) Tipos de Ordenação (opções abaixo)
FilterCPF Character(11) CPF, apenas números
FilterCNPJ Character(14) CNPJ, apenas números
NumPag Integer Número de paginação
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg93=gb",
"OrderReg": "PessoaCodigo",
"FilterCPF": "12312312312",
"FilterCNPJ": "",
"NumPag": 1
}


OrderReg opções:


Então faça a requisição abaixo:

POST

/api_sgo.WSConsultaPessoas



PessoaCodigo: Id da pessoa no sistema
PessoaTipo: Tipo de pessoa (física ou jurídica)
PessoaCNPJ: CNPJ, apenas números
PessoaIE: Inscrição Estadual
PessoaCPF: CPF, apenas números
PessoaRG: Registro Geral da pessoa
PessoaRazaoSocial: Razão Social da pessoa
PessoaNomeFantasia: Nome fantasia da pessoa
PessoaCEP: Código Postal
PessoaLogradouro: Nome da Rua
PessoaNumero: Número do endereço
PessoaComplemento: Complemento do endereço
PessoaBairro: Bairro
PessoaNomeMunicipio: Cidade
EstadoUF: Estado
PessoaCodigoMunicipio: Código Município
PessoaCodigoPais: Código País
PessoaNomePais: Nome do País
PessoaDDDFone: Telefone
PessoaCelular: Celular
PessoaSUFRAMA: Código SUFRAMA
PessoasSite: Site
PessoaEmail: Email
PessoaCliente: Cadastrado como Cliente
PessoaFornecedor: Cadastrado como fornecedor
PessoaVendedor: Cadastrado como vendedor
PessoaTransportador: Cadastrado como Transportador
PessoaOBS: Observações
PessoaCEPEntrega: Código Postal para entrega
PessoaLogradouroEntrega: Rua para entrega
PessoaNumeroEntrega: Número para entrega
PessoaComplementoEntrega: Complemento para entrega
PessoaBairroEntrega: Bairro para entrega
PessoaNomeMunicipioEntrega: Cidade para entrega
PessoaEstadoUFEntrega: Estado para entrega
PessoaCEPCobranca: Código Postal para cobrança
PessoaLogradouroCobranca: Rua para cobrança
PessoaNumeroCobranca: Número para cobrança
PessoaComplementoCobranca: Complemento para cobrança
PessoaBairroCobranca: Bairro para cobrança
PessoaNomeMunicipioCobranca: Cidade para cobrança
PessoaEstadoUFCobranca: Estado para cobrança
PessoaVendedorComissao: Comissão de vendas
PessoaAtivo: Se a pessoa está ativa no sistema (S ou N)


				Resposta:
[
{
"PessoaCodigo":1640,
"PessoaTipo":"Física ",
"PessoaCNPJ":" ",
"PessoaIE":" ",
"PessoaCPF":"12312312312",
"PessoaRG":" ",
"PessoaRazaoSocial":"Fulano de tal",
"PessoaNomeFantasia":"Fulano de tal",
"PessoaCEP":12345678,
"PessoaLogradouro":"Rua dos Jardins",
"PessoaNumero":"400 ",
"PessoaComplemento":"casa",
"PessoaBairro":"Nova Morada",
"PessoaNomeMunicipio":"São Paulo",
"EstadoUF":"SP",
"PessoaCodigoMunicipio":3516200,
"PessoaCodigoPais":1058,
"PessoaNomePais":"BRASIL ",
"PessoaDDDFone":11990000000,
"PessoaCelular":11990000000,
"PessoaSUFRAMA":" ",
"PessoasSite":"",
"PessoaEmail":"fulano@gmail.com",
"PessoaCliente":"S",
"PessoaFornecedor":"N",
"PessoaVendedor":"N",
"PessoaTransportador":"N",
"PessoaOBS":"",
"PessoaCEPEntrega":0,
"PessoaLogradouroEntrega":"",
"PessoaNumeroEntrega":"",
"PessoaComplementoEntrega":"",
"PessoaBairroEntrega":"",
"PessoaNomeMunicipioEntrega":"",
"PessoaEstadoUFEntrega":"",
"PessoaCEPCobranca":0,
"PessoaLogradouroCobranca":"",
"PessoaNumeroCobranca":"",
"PessoaComplementoCobranca":"",
"PessoaBairroCobranca":"",
"PessoaNomeMunicipioCobranca":"",
"PessoaEstadoUFCobranca":"",
"PessoaVendedorComissao":0,
"PessoaAtivo":"S"
}
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro.

{
"error":{
"code":"500",
"message":"Error"
}
}

Produtos

Consultar Categorias

Este método permite consultar todas as Categorias cadastradas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo.WSConsultaCategorias



TGruposProdutosCodigo: Id da Categoria
TGruposProdutosDescricao: Nome da Categoria
TGruposProdutosCodigoPai: ID da Categoria Pai
TGruposProdutosImagem: Imagem da Categoria
TGruposProdutosImagem_GXI: Ícone da Categoria


				Resposta:
[
{
"TGruposProdutosCodigo":8,
"TGruposProdutosDescricao":"Categoria Principal ",
"TGruposProdutosCodigoPai":0,
"TGruposProdutosImagem":" ",
"TGruposProdutosImagem_GXI":" "
},...
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro.

{
"error":{
"code":"500",
"message":"Error"
}
}

Consultar Marcas

Este método permite consultar todas as Marcas cadastradas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo.WSConsultaMarcas



TMarcasCodigo: Id da Marca
TMarcasDescricao: Nome da Marca


				Resposta:
[
{
"TMarcasCodigo": 1,
"TMarcasDescricao": "GESTÃO ONLINE"
},...
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro.

{
"error":{
"code":"500",
"message":"Error"
}
}

Consultar Produtos

Este método permite consultar as informações de determinado produto, através do código EAN ou SKU, permitindo filtrar por Categoria ou Marca.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
OrderReg Character(18) Tipos de Ordenação (opções abaixo)
FilterCategoria Integer Id da Categoria
FilterEAN Character(13) Código EAN do produto
FilterSKU Character(20) Código SKU do produto
FilterMarca Integer Id da Marca
NumPag Integer Número de paginação
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"OrderReg": "ProdutoCodigo",
"FilterCategoria": 0,
"FilterEAN": "1254021859741",
"FilterSKU": "",
"FilterMarca": 0,
"NumPag": 1
}


OrderReg opções:


Então faça a requisição abaixo:

POST

/api_sgo.WSConsultaProdutos



ProdutoCodigo: Id do produto
ProdutoTipo: Tipo do produto
ProdutoCodigoEAN: EAN do produto
TGruposProdutosCodigo: Id da Categoria
ProdutoDescricao: Nome do produto
ProdutoUND: Unidade do produto
NCM: NCM do produto
ProdutoValorCompra: Valor de compra do produto
ProdutoPerLucro: Porcentagem de lucro sobre o produto
ProdutoValorVenda: Valor de venda do produto
ProdutoPesoLiq: Peso líquido do produto
ProdutoPesoBruto: Peso bruto do produto
ProdutoAtivo: Status de ativo do produto
ProdutoObs: Observações do produto
ProdutoOcultarPDV: Valor 1 caso este produto deve aparecer no PDV
ProdutoEstoque: Quantidade em estoque do produto
ProdutoReferencia: SKU do produto
ProdutoDescricaoCompleta: Descrição completa do produto
ProdutoComprimento: Comprimento do produto
ProdutoLargura: Largura do produto
ProdutoAltura: Altura do produto
TMarcasCodigo: Id da Marca
ProdutoURLVideo: URL do vídeo do produto
ProdutoRetiraLocal: Retirada no local
ProdutoNovoUsado: Estado do produto (Novo ou Usado)
ProdutoValorVendaECommerce: Valor de venda em Ecommerce
ProdutoDescricaoGarantia: Descrição da garantia
ProdutoFreteGratis: Frete Grátis (0 - não 1 - sim)
ProdutoTagTitle: meta tag título do produto
ProdutoMetaTagDescription: meta tag descrição
ProdutoMetaTagKeywords: meta tag palavras-chave
ProdutoFornecedor: Id do Fornecedor
ProdutoImagemItem: Id da imagem
ProdutoImagem: URL da imagem do produto
ProdutoImagem_GXI: URL do objeto da imagem
ProdutoVariacao: Id da Variação
ProdutoVariacaoEstoque: Quantidade em estoque da variação
ProdutoVariacaoSKU: SKU da variação
AtributoDescricao: Descrição do Atributo
AtributoConteudo: Conteúdo do Atributo


				Resposta:
[
{
"ProdutoCodigo": 427,
"ProdutoTipo": 1,
"ProdutoCodigoEAN": "000000",
"TGruposProdutosCodigo": 23,
"ProdutoDescricao": "Bolsa de Bebê Lisa",
"ProdutoUND": "UNID",
"NCM": "42022220",
"ProdutoValorCompra": 0.01,
"ProdutoPerLucro": 0,
"ProdutoValorVenda": 90.48,
"ProdutoPesoLiq": 333,
"ProdutoPesoBruto": 333,
"ProdutoAtivo": "S",
"ProdutoObs": "AZUL/PINK",
"ProdutoOcultarPDV": "",
"ProdutoEstoque": 39,
"ProdutoReferencia": "ABC15002-AZ-PK",
"ProdutoDescricaoCompleta": "Bolsa para bebê com alça",
"ProdutoComprimento": 37,
"ProdutoLargura": 16,
"TMarcasCodigo": 0,
"ProdutoURLVideo": "https://www.youtube.com/watch?",
"ProdutoRetiraLocal": "Nao",
"ProdutoNovoUsado": "new",
"ProdutoValorVendaECommerce": 0,
"ProdutoDescricaoGarantia": "",
"ProdutoFreteGratis": "1",
"ProdutoTagTitle": "",
"ProdutoMetaTagDescription": "",
"ProdutoMetaTagKeywords": "",
"ProdutoFornecedor": 0,
"ProdutoImagem": [,
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\57ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br",
},
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\86857ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br",
}
],
"Variacoes": [
{
"ProdutoVariacao": 8,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-M"
},
"ProdutoVariacao": 9,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P",
}
],
"Atributos": [
{
"AtributoDescricao": "Alças",
"AtributoConteudo": "3"
},
"AtributoDescricao": "Material",
"AtributoConteudo": "Couro"
}
]
}
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro.

{
"error":{
"code":"500",
"message":"Error"
}
}

Consultar Variações

Este método permite consultar todas as Variações de um determinado produto.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoReferencia Character(20) SKU do produto
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg3=gb",
"ProdutoReferencia": "ABC15002-AZ-PK"
}


Então faça a requisição abaixo:

POST

/api_sgo.WSConsultaVariacoes



ProdutoVariacaoEstoque: Quantidade em estoque da variação
ProdutoVariacaoDescricao: Nome da Variação
ProdutoVariacaoNome: Identificação da variação
ProdutoVariacaoSKU: SKU da Variação
ProdutoVariacao: Id da Variação


				Resposta:
[
{
"ProdutoVariacaoEstoque": 8,
"ProdutoVariacaoDescricao": "P":,
"ProdutoVariacaoNome": "",
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P",
"ProdutoVariacao": 9
},...
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro.

{
"error":{
"code":"500",
"message":"Error"
}
}