Академический Документы
Профессиональный Документы
Культура Документы
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
Consulta de Produtos
Consulta de Produtos
GET
GET
Consulta de Produtos
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
Consulta de Produtos
Consulta de Produtos
GET
GET
Consulta de Produtos
GET
Consulta de Produtos
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
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
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
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[ ]
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
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
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
7.4
Para o cadastro/alterao de pessoas, deve ser enviado pelo modulo do cliente no Body da requisio a
seguinte entidade no formato json:
Entidade Pessoa
Campo da Entidade
PessoaFisica
Tipo de Dado
boolean
Descrio
Indica se a pessoa fsica ou jurdica
NomeFantasia
string
RazaoSocial
string
CNPJ_CPF
string
RG
string
IE
string
Inscrio Estadual
Logradouro
string
LogradouroNumero
string
Logradouro Nmero
Complemento
string
Complemento
Bairro
string
Bairro
Cidade
string
Municpio/Cidade
CodigoMunicipio
string
Pais
string
Pas
CodigoPais
string
CEP
string
CEP
UF
string
UF
CodigoUF
string
Cdigo UF IBGE
Telefone
string
Telefone
Celular
string
Celular
string
Cliente
boolean
Tecnico
boolean
Vendedor
boolean
Transportadora
boolean
Fornecedor
boolean
Representada
Ramo
string
VendedorPadrao
string
NomePai
string
Nome do pai
NomeMae
string
Nome da me
Naturalidade
string
Naturalidade
ValorMinimoCompra
double
DataNascimento
boolean
date
Data de nascimento
7.5
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
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/pessoas/pesquisar?nomefantasia=&cpfcnpj=&cidade=&uf=&cliente=false&fornecedor=
false&pageSize=10&skip=0
7.6
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
Pratileira
string
NumeroSerie
string
Nome
string
Nome do produto
Genero
string
EstoqueUnidade
string
Especificacao
string
PesoKG
double
PrecoCusto
double
LucroDinheiro
double
LucroPercentual
double
PrecoVenda
double
PrecoMinimoVenda
double
EstoqueRisco
double
DepositoPadrao
double
EstoqueSaldo
double
NCM
string
GrupoTributario
string
GeneroFiscal
string
CFOPPadrao
string
UnidadeTributavel
string
OrigemMercadoria
int
VisivelSite
boolean
DestaqueSite
boolean
IgnorarEstoque
boolean
FreteGratis
boolean
Ativo
boolean
FiltrosCategoria
string
PercentualDescontoBoleto
double
Comprimento
double
Altura
double
Largura
double
7.7
Descrio
Cdigo do produto
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtos/get?codigo=seucodigo
7.8
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
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/produtos/pesquisar?codigo=&numeroSerie=&nome=&genero=&categoria=false&marc
a=false&pageSize=10&skip=0
7.9
Descrio
Nome do produto a ser pesquisado
Categoria do produto no E-commerce
Marca do produto no E-commerce
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/produtos/pesquisaecommerce?pesquisa=&categoria=false&marca=false&pageSize=10
&skip=0
7.10
Descrio
Nome do produto a ser pesquisado
Categoria do produto no E-commerce
Marca do produto no E-commerce
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
https://api.sigecloud.com.br/request/produtos/pesquisaecommercecount?pesquisa=&categoria=false&marca=false
7.11
Descrio
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/produtos/todosecommerce?pagesize=10&skip=0
7.12
7.13
Descrio
Nome Web do produto
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?nomeweb=seunomeweb
7.14
Descrio
Cdigo do produto
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?codigo=seucodigo
7.15
Descrio
Categoria do produto no E-commerce
Marca do produto no E-commerce
Quantidade de produto no E-commerce
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtos/produtosrelacionadosecommerce?categoria=suacategoria&&marca=suamarc
a&&quantidade=4
7.16
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
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/cep/get?cep=seuCEPaqui
7.17
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
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/configuracao/get
7.18
7.19
Tipo de Dado
string
Descrio
Define o nome da marca do produto
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/marca/get
7.20
Tipo de Dado
string
string
string
Descrio
Define o cdigo hierrquico da categoria
Define o nome da categoria
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/categoria/get
7.21
Descrio
Define o tamanho exato do banner do E-commerce
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/banners/getidsbytipo?tipo=seutipo
7.22
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
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/banners/allbytipo?tipo=seutipo
7.23
Para facilitar a consulta foram definidos parmetros de filtragem de resultados para a pesquisa, sendo estes
os parmetros disponveis:
Parametro
id
Descrio
Define o ID do banner do E-commerce
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/banners/getimagembyid?id=seuid
7.24
Descrio
Define o ID do banner do E-commerce
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/banners/getbyid?id=seuid
7.25
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
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtosfotos/getimagemprincipalbyproduto?codigoproduto=seucodigoproduto
7.26
Descrio
Cdigo do produto no SIGE Cloud
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
http://api.sigecloud.com.br/request/produtosfotos/getimagensbyproduto?codigoproduto=seucodigoproduto
7.27
Descrio
ID da imagem no E-commerce
Define se a imagem ou no uma miniatura
Estes parmetros devem ser enviados na forma de query string como no seguinte exemplo:
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.