Sige Cloud Integração API Rest

Documento de Integrao API SIGE Cloud
1. Introduo
O SIGE Cloud um ERP para micro e pequenas empresas cujo foco est na melhoria contnua de suas
funcionalidades, sempre visando a simplicidade e produtividade aos seus cliente. Desta forma para que seus clientes
tivessem uma maneira de integrar seus sistemas legados ao SIGE Cloud, foi desenvolvida uma API de Integrao.
2. Objetivo
Este documento tem por objetivo informar aos clientes SIGE Cloud, os dados tcnicos cabveis para a integrao de
seu modulo cliente API de integrao disponibilizada pelo SIGE Cloud.
3. Escopo
Este documento abordar de maneira objetiva os padres utilizados durante a troca de mensagem entre o modulo
cliente e a API, bem como expor as entidades definidas para esta troca de mensagens.
4. Dos Padres
Visando simplicidade e produtividade, a API de Integrao SIGE Cloud foi desenvolvida utilizando-se dos conceitos
RESTful (http://pt.wikipedia.org/wiki/REST), sendo que utilizasse unicamente do protocolo HTTPS para a troca de
mensagens entre o modulo cliente e API, com as mensagens trocadas obedecendo estrutura a JSON e encoding
UTF-8.
Os campos do tipo date devem estar no formato UTC, como o seguinte exemplo :
2013-11-14T00:00:00-02:00
5. Autenticao
Para garantir a segurana e privacidade dos dados dos clientes que optarem por utilizar a API de Integrao SIGE
Cloud, alm de disponibilizar os mtodos consumveis atravs de protocolo HTTPS, foram definidas formas de
autenticao para o cliente, mantendo assim a privacidade dos dados.
Para que esta autenticao seja possvel no Header de cada requisio realizada pelo modulo do cliente a API de
Integrao devem constar os seguintes cabealhos:
Authorization-Token: 123456789
User: teste@email.com.br
App: xyz
Deve ser observado que os dados acima apresentados so fictcios, e que os reais dados para integrao so
fornecidos pela equipe tcnica do SIGE Cloud, devendo estes ser solicitados mesma, para que seja possvel a
integrao. Para solicitar estes dados deve ser enviado um email para suporte@sigecloud.com.br do email
administrador da conta no SIGE Cloud com o assunto Solicitao de dados de autenticao API SIGE Cloud.
Estes dados sero enviados em at 48 horas aps a solicitao.
6. Mtodos Consumveis
Atualmente a API disponibiliza a seguinte lista de mtodos:
Finalidade
Verbo HTTP
URL
Pesquisa de Pedidos
GET
http://api.sigecloud.com.br/request/pedidos/pesquisar
Cadastro de Pedidos
POST
http://api.sigecloud.com.br/request/pedidos/salvar
Cadastro de Movimentao de
Estoque
Cadastro/Alterao de Pessoas
POST
http://api.sigecloud.com.br/request/produtosestoque/salvar
POST
http://api.sigecloud.com.br/request/pessoas/salvar
Pesquisa de Pessoas
GET
http://api.sigecloud.com.br/request/pessoas/pesquisar
Cadastro/Alterao de produtos
POST
http://api.sigecloud.com.br/request/produtos/salvar
Consulta de Produtos
GET
http://api.sigecloud.com.br/request/produtos/get
Pesquisa de Produtos
GET
http://api.sigecloud.com.br/request/produtos/pesquisar
GET
GET
GET
http://api.sigecloud.com.br/request/produtos/pesquisaecommerce
http://api.sigecloud.com.br/request/produtos/pesquisaecommercecoun
t
http://api.sigecloud.com.br/request/produtos/todosecommerce
GET
GET
GET
GET
Pesquisa de CEP
GET
http://api.sigecloud.com.br/request/produtos/todosecommercecount
http://api.sigecloud.com.br/request/produtos/getbynomewebecommer
ce
http://api.sigecloud.com.br/request/produtos/getbycodigoecommercec
ount
http://api.sigecloud.com.br/request/produtos/produtosrelacionadoseco
mmerce
http://api.sigecloud.com.br/request/cep/get
Cadastro de Configuraes
GET
http://api.sigecloud.com.br/request/configuracoes/get
Clculo de Frete
POST
http://api.sigecloud.com.br/request/calculofrete/calcular
Consulta de Marcas
GET
http://api.sigecloud.com.br/request/marcas/get
Consulta de Categorias
GET
http://api.sigecloud.com.br/request/categoria/get
Consulta de Banners
GET
http://api.sigecloud.com.br/request/banners/getidsbytipo
Consulta de Banners
GET
http://api.sigecloud.com.br/request/banners/allbytipo
Consulta de Banners
GET
http://api.sigecloud.com.br/request/banners/getbyid
Consulta de Banners
GET
http://api.sigecloud.com.br/request/banners/getimagembyid
Consulta de Imagem dos Produtos
GET
http://api.sigecloud.com.br/request/produtosfotos/getimagemprincipal
byproduto
GET
GET
http://api.sigecloud.com.br/request/produtosfotos/getimagenslbyprod
uto
http://api.sigecloud.com.br/request/produtosfotos/getimagem
7. Descrio dos Mtodos Consumveis

7.1
Pesquisa de Pedidos - /pedidos/pesquisar

Este mtodo destinasse exclusivamente a consulta de pedidos cadastrados no SIGE Cloud sendo que devem
ser feitas requisies GET atravs do modulo do cliente para a API de Integrao.
Para facilitar a consulta foram definidos parmetros de filtragem de resultados para a pesquisa, sendo estes
os parmetros disponveis:
Parametro
codigo
origem
status
cliente
pagesize
skip
Descrio
Cdigo de pedido
Origem do pedido
Status do pedido
Nome/Razo Social do cliente relacionado ao pedido
Numero Maximo de resultados retornados por pagina
Numero de paginas de resultado a serem puladas
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo :
http://api.sigecloud.com.br/request/pedidos/pesquisar?codigo=0&origem=&status=&categoria=&cliente=&pageSize=10&sk
ip=0
7.2
Cadastro de Pedidos - /pedidos/Salvar ou /pedidos/SalvarEFaturar

Este mtodo destinasse ao cadastro e alterao de pedidos no SIGE Cloud sendo que devem ser feitas
requisies POST atravs do modulo do cliente para a API de Integrao.
Cabe ressaltar que a alterao realiza quando enviada para a API de Integrao uma requisio contendo
um pedido com o cdigo j existente em um pedido cadastrado no SIGE Cloud, sendo que o pedido
existente no SIGE Cloud sobrescrito pelo novo pedido enviado a API de Integrao.
Para o cadastro/alterao de pedidos, deve ser enviado pelo modulo do cliente no Body da requisio a
seguinte entidade no formato json:
Entidade Pedido
Campo da Entidade
Codigo
OrigemVenda
Deposito
Tipo de Dado
int
string
string
StatusSistema
string
Status
string
Descrio
Codigo do pedido a ser assumido pelo sistema
Origem da venda
Nome do deposito do qual os produtos da venda sero
retirados
Status padro do sistema para os pedidos sendo que
devem ser respeitadas as seguintes opes :
Oramento, Pedido, Pedido No Faturado, Pedido
Faturado, Pedido Cancelado
Status definido pelo usurio
Categoria
string
Validade
Empresa
Cliente
ClienteCNPJ
date
string
string
string
Vendedor
LancarComissaoVendedor
string
boolean
PlanoDeConta
string
FormaPagamento
string
NumeroParcelas
string
Transportadora
FreteFormaEnvio
DataEnvio
PrevisaoEntrega
DataPostagem
Enviado
ValorFrete
FreteContaEmitente
CodigoRastreio
ValorSeguro
Descricao
OutrasDespesas
TransacaoCartao
ValorFinal
Finalizado
Lancado
Municipio
CodigoMunicipio
Pais
CEP
UF
UFCodigo
Bairro
Logradouro
LogradouroNumero
LogradouroComplemento
Items
string
string
date
date
date
boolean
double
boolean
string
double
string
double
string
double
boolean
boolean
string
string
string
string
string
string
string
string
string
string
PedidoProduto[ ]
Categoria da venda. Deve estar previamente

cadastrada no sistema.
Data de validade do Pedido/Oramento
Nome da empresa responsvel pela venda
Nome do cliente relacionado a venda
CNPJ do cliente relacionado a venda e utilizado como
atributo de vinculo com clientes e fornecedores j
cadastrados no sistema
Nome do vendedor relacionado a venda
Indica se a comisso do vendedor, referente aos itens
do pedido ser lanada no financeiro ao salvar o
pedido
Plano de conta da venda, sendo que deve estar
previamente cadastrado no sistema
Forma de Pagamento escolhida, deve estar
previamente cadastrada.
Nmero de Parcelas em que ser efetuado o
pagamento
Nome da responsvel pelo transporte da mercadoria.
Formato de Envio do Produto
Data de envio da mercadoria
Data de previso de entrega
Data de postagem
Informa se a mercadoria foi enviada
Valor do Frete
Indica se o frete por conta do emitente
Cdigo de rastreamento da entrega
Valor do Seguro
Descrio e observaes relacionados ao pedido.
Outras despesas que devem ser acrescentadas ao valor
final do pedido
Cdigo da Transao de Carto (TID)
Valor Final do Pedido
Pedido finalizado no pode sofrer alteraes
Pedido j lanado pelo financeiro
DADOS DE ENTREGA: nome do municpio.
DADOS DE ENTREGA: cdigo do municpio.
DADOS DE ENTREGA: Nome do pais.
DADOS DE ENTREGA: CEP 99999-999.
DADOS DE ENTREGA:UF
DADOS DE ENTREGA: Cdigo UF
DADOS DE ENTREGA: Nome do Bairro
DADOS DE ENTREGA: Logradouro
DADOS DE ENTREGA: Nmero do Logradouro
DADOS DE ENTREGA: Complemento
Array do tipo PedidoProduto contendo os produtos
do pedido
Entidade PedidoProduto
Campo da Entidade
Codigo
Unidade
Descricao
Tipo de Dado
string
string
string
Descrio
Cdigo do produto
Unidade de Medida
Descrio
Quantidade
ValorUnitario
ValorFrete
DescontoUnitario
Desconto Total
ComissaoVendedor
double
double
double
double
double
double
PesoKG
Comprimento
Altura
Largura
FreteGratis
ValorUnitarioFrete
PrazoEntregaFrete
double
double
double
double
boolean
double
int
Exemplo das entidades na estrutura json :

{"Codigo":169,
"OrigemVenda":"Venda Direta",
"Deposito":"Tupandi",
"StatusSistema":"Oramento",
"Status":"",
"Categoria":"",
"Validade":"2013-11-14T00:00:00-02:00",
"Empresa":"Creative Mais",
"Cliente":"Venda do Diego",
"Vendedor":"login@vendedor.com",
"LancarComissaoVendedor":true,
"PlanoDeConta":"",
"FormaPagamento":"",
"NumeroParcelas":0,
"Transportadora":"",
"DataEnvio":"0001-01-01T00:00:00-02:00",
"Enviado":false,
"ValorFrete":0.0,
"FreteContaEmitente":false,
"ValorSeguro":0.0,
"Descricao":"",
"OutrasDespesas":0.0,
"ValorFinal":1532.65,
"Finalizado":false,
"Lancado":false,
"Municipio":"Bom Princpio",
"CodigoMunicipio":"4302352",
"Pais":"Brasil",
"CEP":"95765000",
"UF":"RS",
"UFCodigo":"43",
"Bairro":"",
"Logradouro":"Rua Mambu",
"LogradouroNumero":"951",
"LogradouroComplemento":"Casa ",
"Items":[
{"Codigo":"41",
"Unidade":"",
"Descricao":"SERVIOS GERAIS",
Quantidade
Valor de Venda Unitrio
Desconto Total
Desconto de Venda Unitrio
Desconto Total
O percentual de comisso que o vendedor recebe sobre
este item
Peso em KG
Comprimento
Altura
Largura
Indica se o frete grtis
Valor Unitrio do Frete
Prazo de Entrega em dias
"Quantidade":1.0,
"ValorUnitario":10.0,
"DescontoUnitario":0.0,
"ValorTotal":10.0},
{"Codigo":"12",
"Unidade":"",
"Descricao":"WEB CAN",
"Quantidade":15.0,
"ValorUnitario":101.51,
"DescontoUnitario":0.0,
"ComissaoVendedor":10.0,
"ValorTotal":1522.65}]}
A API de Integrao realiza diversas validaes nos dados recebidos, sendo que caso os dados enviados
no sejam validados, a API de Integrao ir retornar uma mensagem informando o no sucesso na
operao de modificao/incluso com a descrio da falha de validao ocorrida.
7.3
Cadastro de Movimentaes de Estoque - /produtosestoque/salvar

Este mtodo destinasse somente ao cadastro de movimentaes de estoque no SIGE Cloud sendo que
devem ser feitas requisies POST atravs do modulo do cliente para a API de Integrao.
Para o cadastro de movimentaes de estoque, deve ser enviado pelo modulo do cliente no Body da
requisio a seguinte entidade no formato json:
Entidade EstoqueMovimentacao
Campo da Entidade
Tipo de Dado
ProdutoCodigo
int
DepositoNome
string
Quantidade
double
EhEntrada
boolean
Descrio
Codigo do produto no sistema
Nome do deposito a ser realizada a operao
Quantidade de produtos a ser creditada ou debitada do
estoque
Indica se a operao de entrada ou sada do estoque
Exemplo da entidade na estrutura json :

{"ProdutoCodigo":"001",
"DepositoNome":"Geral",
"Quantidade":1.0,
"EhEntrada":true}
7.4
Cadastro/Alterao de Pessoas - /pessoas/salvar

Este mtodo destinasse ao cadastro e alterao de clientes/fornecedores no SIGE Cloud sendo que devem
ser feitas requisies POST atravs do modulo do cliente para a API de Integrao.
Cabe ressaltar que a alterao realiza quando enviada para a API de Integrao uma requisio contendo
uma pessoa com um CPF/CNPJ j existente em uma pessoa cadastrada no SIGE Cloud, sendo que a pessoa
existente no SIGE Cloud sobrescrita pela nova pessoa enviada a API de Integrao.
Para o cadastro/alterao de pessoas, deve ser enviado pelo modulo do cliente no Body da requisio a
Entidade Pessoa
Campo da Entidade
PessoaFisica
Tipo de Dado
boolean
Descrio
Indica se a pessoa fsica ou jurdica
NomeFantasia
string
Nome ou nome fantasia da pessoa
RazaoSocial
string
A razo social da pessoa se for pessoa jurdica
CNPJ_CPF
string
Indica se a operao de entrada ou sada do estoque
RG
string
RG, somente para pessoas fsica
IE
string
Inscrio Estadual
Logradouro
string
Logradouro. Ex.: Av. Brasil
LogradouroNumero
string
Logradouro Nmero
Complemento
string
Complemento
Bairro
string
Bairro
Cidade
string
Municpio/Cidade
CodigoMunicipio
string
Cdigo do Municpio IBGE
Pais
string
Pas
CodigoPais
string
Cdigo do Pas IBGE
CEP
string
CEP
UF
string
UF
CodigoUF
string
Cdigo UF IBGE
Telefone
string
Telefone
Celular
string
Celular
Email
string
Email
Cliente
boolean
Indica se a pessoa um cliente
Tecnico
boolean
Indica se a pessoa um tcnico
Vendedor
boolean
Indica se a pessoa um vendedor
Transportadora
boolean
Indica se a pessoa um transportador
Fornecedor
boolean
Indica se a pessoa um fornecedor
Representada
Ramo
string
Se faz papel de Representada (EXCLUSIVO PARA CASOS

DE VENDAS POR REPRESENTAO)
Ramo de Atuao
VendedorPadrao
string
Vendedor Padro - (Responsvel pela conta)
NomePai
string
Nome do pai
NomeMae
string
Nome da me
Naturalidade
string
Naturalidade
ValorMinimoCompra
double
Valor mnimo para compra
DataNascimento
boolean
date
Data de nascimento

{"ID":"526fa0c9e955158bb0325578",
"PessoaFisica":false,
"NomeFantasia":"Eletro Peas Vargas",
"RazaoSocial":"Arinda Borges Vargas Me",
"CNPJ_CPF":"1468601000196",
"RG":"",
"IE":"85766406",
"Logradouro":"RUA BUARQUE DE NAZARETH",
"LogradouroNumero":"434",
"Complemento":"",
"Bairro":"",
"Cidade":"ITAPERUNA",
"CodigoMunicipio":"3302205",
"Pais":"BR",
"CodigoPais":"1058",
"CEP":"28300000",
"UF":"RJ",
"CodigoUF":" ",
"Telefone":"(22) 3824-3827",
"Celular":null,
"Email":"arindabvargas@yahoo.com.br",
"Site":" ",
"Cliente":true,
"Tecnico":false,
"Vendedor":false,
"Transportadora":false,
"Fonecedor":false,
"Representada":false,
"Ramo":"Nenhum",
"VendedorPadrao":" ",
"NomePai":" ",
"NomeMae":" ",
"Naturalidade":" ",
"ValorMinimoCompra":0.0,
"DataNascimento":"0001-01-01T00:00:00-02:00" }
7.5
Pesquisa de Pessoas - /pessoas/pesquisar

Este mtodo destinasse exclusivamente a consulta de pessoas cadastradas no SIGE Cloud sendo que devem
ser feitas requisies GET atravs do modulo do cliente para a API de Integrao.
Parametro
nomefantasia
cpfcnpj
cidade
uf
cliente
fornecedor
pagesize
skip
Descrio
Nome/Nome fantasia da pessoa
CPF/CNPJ da pessoa
Cidade
UF
Indica se a filtragem deve considerar apenas clientes
Indica se a filtragem deve considerar apenas
fornecedores
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/pessoas/pesquisar?nomefantasia=&cpfcnpj=&cidade=&uf=&cliente=false&fornecedor=
false&pageSize=10&skip=0
7.6
Cadastro/Alterao de Produtos - /produtos/salvar

Este mtodo destinasse ao cadastro e alterao de produtos no SIGE Cloud sendo que devem ser feitas
requisies POST atravs do modulo do cliente para a API de Integrao.
Para o cadastro/alterao de pessoas, deve ser enviado pelo modulo do cliente no Body da requisio a
Entidade Produto
Campo da Entidade
Categoria
Tipo de Dado
string
Marca
string
Descrio
Indica a categoria do produto. Deve ser previamente
cadastrada
Marca do produto. Deve se previamente cadastrada
Fornecedor
string
Fornecedor do produto
Codigo
string
Indica o cdigo do produto informado pelo cliente
Pratileira
string
Indica em qual prateleira se encontra o produto
NumeroSerie
string
Indica o nmero de srie do produto
Nome
string
Nome do produto
Genero
string
Gnero do produto. Ex: Mercadoria para revenda. Deve

ser previamente cadastrado
EstoqueUnidade
string
Especificacao
string
Indica a unidade de estoque do produto.Ex; kg, m,

caixa, etc. Deve ser previamente cadastrada
Indica informaes adicionais do produto
PesoKG
double
Peso do produto, conforme sua unidade.
PrecoCusto
double
Preo de custo do produto
LucroDinheiro
double
Lucro em dinheiro sobre o valor do produto
LucroPercentual
double
Percentual de lucro sobre o valor do produto
PrecoVenda
double
Preo de venda do produto
PrecoMinimoVenda
double
Preo mnimo de venda do produto
EstoqueRisco
double
DepositoPadrao
double
Indica o depsito padro do produto
EstoqueSaldo
double
Indica o saldo do produto no estoque
NCM
string
Cdigo NCM do produto
GrupoTributario
string
Indica o grupo tributrio do produto.
GeneroFiscal
string
CFOPPadrao
string
Indica qual o gnero do produto. Ex: Mercadoria para

Revenda, Produto Acabado, Matria-prima, etc
Indica o cdigo CFOP do produto
UnidadeTributavel
string
Indica a unidade tributvel do produto. Ex: UN, Kg, m,...
OrigemMercadoria
int
VisivelSite
boolean
Indica a origem do produto. Ex: 00 Nacional, 01

Estrangeira Importao direta, 03 EstrangeiraAdquirida no Mercado Interno
Indica se o produto deve ou no ser Exibido no site
DestaqueSite
boolean
Indica se o produto deve ou no ser Destaque no site
IgnorarEstoque
boolean
Ignora a baixa de estoque do produto
FreteGratis
boolean
Indica se o frete do produto ou no grtis
Ativo
boolean
Indica se o produto ou no ativo
FiltrosCategoria
string
Filtros por categoria nos e-commerces
PercentualDescontoBoleto
double
Comprimento
double
Indica o percentual de Desconto na compra de produtos

no boleto
Medida de comprimento do produto
Altura
double
Medida de altura do produto
Largura
double
Medida de largura do produto

{"ID":"8276fa0c9e955158ff4425556",
"Categoria":"Camisetas"
"Marca":"Adidas",
"Fornecedor":"RR Confeccao LTDA",
"Codigo ":"146896",
"Pratileira":"9B",
"NumeroSerie":"806",
"Nome":"Camiseta Adidas Fit",
"Genero":"01- Mercadoria para Revenda",
"EstoqueUnidade":"UN",
"Especificacao":"",
"PesoKG":0.1
"PrecoCusto":45.00,
"LucroDinheiro":"9.00,
"LucroPercentual":"0.2",
"PrecoVenda":54.00
"PrecoMinimoVenda":52.00,
"EstoqueRisco":0.0,
"DepositoPadrao":Deposito1,
"EstoqueSaldo":52.0,
"NCM": 6106.10.00
"GrupoTributario":"Comercializacao",
"GeneroFiscal":"",
"CFOPPadrao":"5102",
"UnidadeTributavel":"UN",
"OrigemMercadoria":00 - Nacional,
"VisivelSite":false,
"DestaqueSite":false,
"IgnorarEstoque":true,
"FreteGratis":false,
"Ativo":true,
"FiltrosCategoria":" ",
"PercentualDescontoBoleto":0.05,
"Comprimento":null,
"Altura":null
"Largura":null }
7.7
Consulta de Produtos - /produtos/get

Este mtodo destinasse exclusivamente consulta de produtos SIGE Cloud, retornando uma entidade
Produto, sendo que devem ser feitas requisies GET atravs do modulo do cliente para a API de
Integrao.
Para facilitar a pesuisa foram definidos parmetros de filtragem de resultados para a pesquisa, sendo estes
Parametro
codigo
Descrio
Cdigo do produto
http://api.sigecloud.com.br/request/produtos/get?codigo=seucodigo
7.8
Pesquisa de Produtos - /produtos/pesquisar

Este mtodo destinasse exclusivamente pesquisa de produtos cadastrados no SIGE Cloud, retornando
uma lista de entidade Produto, sendo que devem ser feitas requisies GET atravs do modulo do cliente
para a API de Integrao.
Para facilitar a pesquisa foram definidos parmetros de filtragem de resultados para a pesquisa, sendo estes
Parametro
codigo
numeroSerie
nome
genero
categoria
marca
pagesize
skip
Descrio
Cdigo do produto
Nmero de srie do produto
Nome do produto
Indica o gnero do produto
Indica se a filtragem deve considerar apenas a categoria
do produto
Indica se a filtragem deve considerar apenas a marca do
produto
http://api.sigecloud.com.br/request/produtos/pesquisar?codigo=&numeroSerie=&nome=&genero=&categoria=false&marc
a=false&pageSize=10&skip=0
7.9
Consulta de Produtos - /produtos/pesquisaecommerce

Este mtodo destinasse exclusivamente consulta de produtos do E-commerce no SIGE Cloud, retornando
Parametro
pesquisa
categoria
marca
pagesize
skip
Descrio
Nome do produto a ser pesquisado
Categoria do produto no E-commerce
Marca do produto no E-commerce
http://api.sigecloud.com.br/request/produtos/pesquisaecommerce?pesquisa=&categoria=false&marca=false&pageSize=10
&skip=0
7.10
Consulta de Produtos - /produtos/ pesquisaecommercecount

o clculo de produtos, sendo que devem ser feitas requisies GET atravs do modulo do cliente para a API
de Integrao.
Parametro
pesquisa
categoria
marca
Descrio
Nome do produto a ser pesquisado
https://api.sigecloud.com.br/request/produtos/pesquisaecommercecount?pesquisa=&categoria=false&marca=false
7.11
Consulta de Produtos - /produtos/ todosecommerce

Parametro
pagesize
skip
Descrio
http://api.sigecloud.com.br/request/produtos/todosecommerce?pagesize=10&skip=0
7.12
Consulta de Produtos - /produtos/ todosecommercecount

o clculo das listas de produtos, sendo que devem ser feitas requisies GET atravs do modulo do cliente
http://api.sigecloud.com.br/request/produtos/todosecommercecount
7.13
Consulta de Produtos - /produtos/ getbynomewebecommrece

uma entidade Produto, sendo que devem ser feitas requisies GET atravs do modulo do cliente para a
API de Integrao.
Parametro
nomeWeb
Descrio
Nome Web do produto
http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?nomeweb=seunomeweb
7.14
Consulta de Produtos - /produtos/ getbycodigoecommrece

uma entidade Produto, sendo que devem ser feitas requisies GET atravs do modulo do cliente para a
API de Integrao.
Parametro
codigo
Descrio
Cdigo do produto
http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?codigo=seucodigo
7.15
Consulta de Produtos - /produtos/ produtosrelacionadosecommerce

Parametro
categoria
marca
quantidade
Descrio
Quantidade de produto no E-commerce
http://api.sigecloud.com.br/request/produtos/produtosrelacionadosecommerce?categoria=suacategoria&&marca=suamarc
a&&quantidade=4
7.16
Consulta de CEP- /cep/get

Este mtodo destinasse exclusivamente consulta de CEP no SIGE Cloud, retornando uma entidade CEP,
sendo que devem ser feitas requisies GET atravs do modulo do cliente para a API de Integrao.
Parametro
CEP
Entidade CEP
Campo da Entidade
CEPNumero
Bairro
MunicipioCodigo
MunicipioNome
EstadoNome
EstadoUF
EstadoCodigoUF
Descrio
Nmero do CEP
Tipo de Dado
string
string
string
string
string
string
string
Descrio
Nmero do CEP correspondente
Bairro da cidade do CEP correspondente
Cdigo do municpio do CEP correspondente
Nome do municpio do CEP correspondente
Nome do Estado do CEP correspondente
Sigla do estado do CEP correspondente
Cdigo do Estado do CEP correspondente
http://api.sigecloud.com.br/request/cep/get?cep=seuCEPaqui
7.17
Consulta de Configuraes - /configuracoes/get

Este mtodo destinasse exclusivamente consulta das configuraes do E-Commerce no SIGE Cloud,
retornando uma entidade Configurao, sendo que devem ser feitas requisies GET atravs do mdulo do
cliente para a API de Integrao.
Entidade Configurao
Campo da Entidade
EcommerceEmpresaPadrao
EcommerceDepositoPadrao
EcommerceTabelaPrecoPadrao
EcommerceParcelasCartao
Tipo de Dado
string
string
string
int
EcommerceIgnorarFreteValorAcimaDe
double
EcommerceValorMinimo
double
Descrio
Define a empresa padro do E-commerce
Define o depsito padro dos produtos do Ecommerce
Define a tabela de preos padro dos
produtos no E-commerce
Define o nmero de parcelas efetuadas com
carto na venda dos produtos no E-commerce
Ignora o frete quando o valor ultrapassa o
valor estabelecido
Valor mnimo de venda de pedidos dentro do
E-commerce
http://api.sigecloud.com.br/request/configuracao/get
7.18
Clculo de Frete - /calculofrete/calcular

Este mtodo destinasse ao clculo do frete da venda de produtos no SIGE Cloud, enviando uma entidade
Pedido, fazendo o clculo de frete dos produtos e retornando uma lista de entidade PedidoProduto, sendo
que devem ser feitas requisies POST atravs do mdulo do cliente para a API de Integrao.
7.19
Consulta de Marcas - /marca/get

Este mtodo destinasse consulta de marcas de produtos no SIGE Cloud, retornando um array de entidade
ProdutoMarca, sendo que devem ser feitas requisies GET atravs do mdulo do cliente para a API de
Integrao.
Entidade ProdutoMarca
Campo da Entidade
Nome
Tipo de Dado
string
Descrio
Define o nome da marca do produto
http://api.sigecloud.com.br/request/marca/get
7.20
Consulta de Categorias - /categoria/get

Este mtodo destinasse exclusivamente consulta de categorias de produtos no SIGE Cloud, retornando
um array de entidade Categoria, sendo que devem ser feitas requisies GET atravs do mdulo do cliente
Entidade ProdutoCategoria
Campo da Entidade
Hierarquia
Nome
Descricao
Tipo de Dado
string
string
string
Descrio
Define o cdigo hierrquico da categoria
Define o nome da categoria
http://api.sigecloud.com.br/request/categoria/get
7.21
Consulta de Banners - /banners/getidsbytipo

Este mtodo destinasse exclusivamente consulta de banners do E-commerce no SIGE Cloud, retornando
uma array de string contendo os IDs dos banners do tipo passado, sendo que devem ser feitas requisies
GET atravs do mdulo do cliente para a API de Integrao.
Parametro
tipo
Descrio
Define o tamanho exato do banner do E-commerce
http://api.sigecloud.com.br/request/banners/getidsbytipo?tipo=seutipo
7.22
Consulta de Banners - /banners/allbytipo

um array de entidade Banner, sendo que devem ser feitas requisies GET atravs do mdulo do cliente
Parametro
tipo
Entidade Banner
Campo da Entidade
Nome
Tipo
Link
Descrio
Define o tamanho exato do banner do E-commerce
Tipo de Dado
string
string
string
Descrio
Define o nome do banner no E-commerce
Define o tamanho exato em pixels do banner
do E-commerce
Define a url destino do banner ao ser clicado
no E-commerce
http://api.sigecloud.com.br/request/banners/allbytipo?tipo=seutipo
7.23
Consulta de Banners - /banners/getimagembyid

uma entidade Banner, sendo que devem ser feitas requisies GET atravs do mdulo do cliente para a API
de Integrao.
Parametro
id
Descrio
Define o ID do banner do E-commerce
http://api.sigecloud.com.br/request/banners/getimagembyid?id=seuid
7.24
Consulta de Banners - /banners/getbyid

um array de bytes contendo a imagem do Banner, sendo que devem ser feitas requisies GET atravs do
mdulo do cliente para a API de Integrao.
Parametro
id
Descrio
Define o ID do banner do E-commerce
http://api.sigecloud.com.br/request/banners/getbyid?id=seuid
7.25
Consulta de Fotos dos Produtos - /produtosfotos/ getimagemprincipalbyproduto

Este mtodo destinasse exclusivamente consulta da foto principal dos produtos no SIGE Cloud,
retornando um entidade ProdutoFoto, sendo que devem ser feitas requisies GET atravs do mdulo do
cliente para a API de Integrao.
Parametro
codigoProduto
Entidade ProdutoFoto
Campo da Entidade
Id
Principal
Descrio
Cdigo do produto no SIGE Cloud
Tipo de Dado
string
boolean
Descrio
Cdigo de identidade da imagem
Define se imagem ou no a imagem
principal do produto
http://api.sigecloud.com.br/request/produtosfotos/getimagemprincipalbyproduto?codigoproduto=seucodigoproduto
7.26
Consulta de Fotos dos Produtos - /produtosfotos/getimagensbyproduto

Este mtodo destinasse exclusivamente consulta das fotos dos produtos no SIGE Cloud, retornando uma
lista de entidade ProdutoFoto, sendo que devem ser feitas requisies GET atravs do mdulo do cliente
Parametro
codigoProduto
Descrio
Cdigo do produto no SIGE Cloud
http://api.sigecloud.com.br/request/produtosfotos/getimagensbyproduto?codigoproduto=seucodigoproduto
7.27
Consulta de Fotos dos Produtos - /produtosfotos/getimagem

Este mtodo destinasse exclusivamente consulta das fotos dos produtos no SIGE Cloud, retornando um
array de bytes se a imagem ou no uma miniatura, sendo que devem ser feitas requisies GET atravs do
mdulo do cliente para a API de Integrao.
Parametro
imagemId
miniatura
Descrio
ID da imagem no E-commerce
Define se a imagem ou no uma miniatura
http://api.sigecloud.com.br/request/produtosfotos/getimagem?imagemId=seuimagemId&&miniatura=true
8. Observaes Finais
Para duvidas ou questes tcnicas sobre a API de Integrao SIGE Cloud, devem ser encaminhados emails para
suporte@sigecloud.com.br com o assunto Duvida API SIGE Cloud.

Sige Cloud Integração API Rest

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Sige Cloud Integração API Rest

Transféré par

Droits d'auteur :

Formats disponibles

Documento de Integrao API SIGE Cloud

Consulta de Imagem dos Produtos

Consulta de Imagem dos Produtos

Consulta de Imagem dos Produtos

7. Descrio dos Mtodos Consumveis

Pesquisa de Pedidos - /pedidos/pesquisar

Cadastro de Pedidos - /pedidos/Salvar ou /pedidos/SalvarEFaturar

Categoria da venda. Deve estar previamente

Exemplo das entidades na estrutura json :

Cadastro de Movimentaes de Estoque - /produtosestoque/salvar

Exemplo da entidade na estrutura json :

Cadastro/Alterao de Pessoas - /pessoas/salvar

Nome ou nome fantasia da pessoa

A razo social da pessoa se for pessoa jurdica

Indica se a operao de entrada ou sada do estoque

RG, somente para pessoas fsica

Logradouro. Ex.: Av. Brasil

Cdigo do Municpio IBGE

Cdigo do Pas IBGE

Indica se a pessoa um cliente

Indica se a pessoa um tcnico

Indica se a pessoa um vendedor

Indica se a pessoa um transportador

Indica se a pessoa um fornecedor

Se faz papel de Representada (EXCLUSIVO PARA CASOS

Vendedor Padro - (Responsvel pela conta)

Valor mnimo para compra

Exemplo da entidade na estrutura json :

Pesquisa de Pessoas - /pessoas/pesquisar

Cadastro/Alterao de Produtos - /produtos/salvar

Indica o cdigo do produto informado pelo cliente

Indica em qual prateleira se encontra o produto

Indica o nmero de srie do produto

Gnero do produto. Ex: Mercadoria para revenda. Deve

Indica a unidade de estoque do produto.Ex; kg, m,

Peso do produto, conforme sua unidade.

Preo de custo do produto

Lucro em dinheiro sobre o valor do produto

Percentual de lucro sobre o valor do produto

Preo de venda do produto

Preo mnimo de venda do produto

Indica o depsito padro do produto

Indica o saldo do produto no estoque

Cdigo NCM do produto

Indica o grupo tributrio do produto.

Indica qual o gnero do produto. Ex: Mercadoria para

Indica a unidade tributvel do produto. Ex: UN, Kg, m,...

Indica a origem do produto. Ex: 00 Nacional, 01

Indica se o produto deve ou no ser Destaque no site

Ignora a baixa de estoque do produto

Indica se o frete do produto ou no grtis

Indica se o produto ou no ativo

Filtros por categoria nos e-commerces

Indica o percentual de Desconto na compra de produtos

Medida de altura do produto

Medida de largura do produto

Exemplo da entidade na estrutura json :

Consulta de Produtos - /produtos/get

Pesquisa de Produtos - /produtos/pesquisar

Consulta de Produtos - /produtos/pesquisaecommerce

Consulta de Produtos - /produtos/ pesquisaecommercecount

Consulta de Produtos - /produtos/ todosecommerce

Consulta de Produtos - /produtos/ todosecommercecount

Consulta de Produtos - /produtos/ getbynomewebecommrece