Token
Esse POST gera o token necessário para autenticação das chamadas na API
curl --location --request POST 'http://focoalternativo.compumate.com.br/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=999' \
--data-urlencode 'password=64134651243651243654' \
--data-urlencode 'grant_type=password'
Status
Esse GET é apenas para teste de funcionalidade da API
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/status' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoTexto/list
Esse GET retorna os textos, cadastrados, de um produto
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtotexto/list?produto=[CODIGO_PRODUTO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoTexto/get
Esse GET retorna os textos, cadastrados, de um produto e tipo de texto
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtotexto/get?produto=[CODIGO_PRODUTO]&tipoTexto=[TIPO_TEXTO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoGrupo/list
Esse GET retorna os grupos, cadastrados
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtogrupo/list' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoGrupo/list
Esse GET retorna os grupos, cadastrados
O parâmetro web=1 são apenas os grupos configurados para aparecerem na internet
O parâmetro web=0 são os grupos configurados para NÃO aparecerem na internet
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtogrupo/list?web=[0_ou_1]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoGrupo/list
Esse GET retorna o grupo
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtogrupo/get?codigo=[CODIGO_GRUPO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoGrupo/list
Esse GET retorna o grupo
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtogrupo/get_bynivel?nivel=[STRING_CODIGO_NIVEL]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/List
Esse GET retorna os produtos, cadastrados
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/list' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/List
Esse GET retorna os produtos, cadastrados
Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757
Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46
Parâmetro data deve ser no formato YYYY-MM-DD ex: 2021-01-29
Parâmetro datainicial é opcional
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/list?datainicial=[DATA]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/List
Esse GET retorna os produtos, cadastrados
Parâmetro ativo deve ser True ou False
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/list?ativo=[TRUE_OU_FALSE]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/List
Esse GET retorna os produtos, cadastrados
Parâmetro ativo deve ser True ou False
Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757
Parâmetro data deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46
Parâmetro data deve ser no formato YYYY-MM-DD ex: 2021-01-29
Parâmetro datainicial é opcional
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/list?ativo=[TRUE_OU_FALSE]&datainicial=[DATA]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/Get
Esse GET retorna o produto, cadastrado
Parâmetro código deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/get?codigo=[CODIGO_PRODUTO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Produto/Verify
Esse GET retorna o produto, cadastrado, e todo o estatus do produto. Pode ser usado para validação antes do pedido.
Parâmetro código deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produto/verify?codigo=[CODIGO_PRODUTO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoArquivo/List
Esse GET retorna os arquivos dos produtos, cadastrados
Parâmetro código do produto deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtoarquivo/list?codigo=[CODIGO_PRODUTO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoArquivo/List
Esse GET retorna os arquivos dos produtos, cadastrados
Parâmetro código do produto deve ser numérico
Parâmetro código do tipo deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtoarquivo/list?codigo=[CODIGO_PRODUTO]&tipo=[CODIGO_TIPO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
ProdutoEstoquePreco/List
Esse GET retorna os estoques e preços dos produtos, cadastrados
Parâmetro produtos deve ser numérico
Parâmetro produtos pode ser uma lista numérica
Parâmetro datainicial deve ser no formato YYYY-MM-DDThh:mm:ss.fff ex: 2021-01-29T07:55:46.757
Parâmetro datainicial deve ser no formato YYYY-MM-DDThh:mm:ss ex: 2021-01-29T07:55:46
Parâmetro datainicial deve ser no formato YYYY-MM-DD ex: 2021-01-29
Parâmetro datainicial é opcional
Parâmetro produtos é opcional
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/produtoarquivo/list?produtos=[CODIGO_PRODUTO_OU_LISTA]&datainicial=[DATA]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido/Get
Esse GET retorna um pedido inserido no sistema.
Parâmetro controle deve ser numérico. Representa a chave do pedido
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/get?controle=[CONTROLE]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido Cliente/Get
Esse GET retorna a lista de pedidos inseridos no sistema que possuem esse identificador de "PedidoCliente".
Parâmetro PedidoCliente deve ser alfanumérico. Representa a chave/id do pedido no sistema cliente.
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/getPedidoCliente?pedidoCliente=[IDENTIFICADOR]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido/Post
Esse POST cadastra um pedido no sistema.
curl --location --request POST 'http://focoalternativo.compumate.com.br/apiv1/pedido/add' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Exemplo de Post para inclusão de Pedido
Atributo Pedido.Pedido você deve ir incrementando para a inclusão de novos pedidos
Atributo Pedido.Cliente será cadastrado no sistema, caso não existir, automaticamente. O campo chave é o documento.
Atributo Pedido.enderecoEntrega não é obrigatório, mas é recomendado. Esse endereço é para onde o produto / encomenda / nota deverá ser enviado.
Atributo Pedido.enderecoCobranca não é obrigatório, mas é recomendado. Esse endereço é para onde os dados e documento de faturamento ee ou cobrança deverão ser enviados.
Caso nenhum endereço for preenchido, será usado o Pedido.Cliente.Endereco. Caso esse usuário faça 2 pedidos com endereços diferentes e caso os pedidos sejam faturados no mesmo momento, ambos os pedidos serão validados com o endereço do último pedido adicionado.
{
"cliente":{
"nome":"Fulano de Tal",
"documento":"90584903006",
"documentoTipo":"CPF",
"rg":"259334868",
"ie":"",
"im":"",
"suframa":"",
"dataNascimento":"1981-01-01",
"sexo":"",
"telefones":
[
{
"contato":"Zé Fulano",
"telefone":"51999998877",
"movel":true
},
{
"contato":"Zé Fulano",
"telefone":"5137939999",
"movel":false
}
],
"email":"fulano@email.com.br",
"endereco":{
"nome":"Casa",
"endereco":"Jacob Becker",
"complemento":"Casa",
"numero":"1824",
"cidade":"Venâncio Aires",
"uf":"RS",
"cep":"95800-000",
"bairro":"Centro",
"pais":"Brasil"
}
},
"clienteObservacao":"Teste Observação",
"enderecoEntrega":{
"nome":"Empresa",
"endereco":"Rua Emílio Selbach",
"complemento":"compumate",
"numero":"825",
"cidade":"Venâncio Aires",
"uf":"RS",
"cep":"95800-000",
"bairro":"Centro",
"pais":"Brasil"
},
"enderecoCobranca":{
"nome":"Casa",
"endereco":"Jacob Becker",
"complemento":"Casa",
"numero":"1824",
"cidade":"Venâncio Aires",
"uf":"RS",
"cep":"95800-000",
"bairro":"Centro",
"pais":"Brasil"
},
"pedido":"TESTE-001",
"dataCriacao":"2021-03-01T01:00:01.123",
"dataModificacao":"2021-03-01T01:00:01.123",
"formaPagamento":{
"descricao":"BOLETO",
"parcelas":1,
"idTransacao":"ID-8123782178397821973",
"data":"2021-03-01T01:00:01.123",
"obs":"observação no boleto - não imprime"
}
"cupom":"cupom5";
"valorDesconto":.0,
"valorAcrescimo":.0,
"valorFrete":350.00,
"valorTotal":5000.59,
"itens":[
{
"codigo":22,
"descricao":"EXPOSITORA DE BEBIDAS VVCD 200L AMARELA 127 V",
"quantidade":1.0,
"unitario":2949.0,
"total":2899.0,
"desconto":50.0
}
],
"transportador": {
"nome": "Correio PAC",
"prazo": "18\/03\/2024 00:00:00",
"obs": null,
"rastreio": "12345",
"rastreioLink":"http://"
}
}
Pedido/getXML
Esse GET retorna o arquivo XML da nota fiscal referente ao pedido, caso tenha sido emitida
Parâmetro controle do pedido deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/getXML?controle=[CONTROLE_PEDIDO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido/getXMLLink
Esse GET retorna um objeto json que contém o link do arquivo XML da nota fiscal referente ao pedido, caso tenha sido emitida
Parâmetro controle do pedido deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/getXMLLink?controle=[CONTROLE_PEDIDO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido/getPDF
Esse GET retorna o arquivo PDF da nota fiscal referente ao pedido, caso tenha sido emitida
Parâmetro controle do pedido deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/getPDF?controle=[CONTROLE_PEDIDO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
Pedido/getPDFLink
Esse GET retorna um objeto json que contém o link do arquivo PDF da nota fiscal referente ao pedido, caso tenha sido emitida
Parâmetro controle do pedido deve ser numérico
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedido/getPDFLink?controle=[CONTROLE_PEDIDO]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'
PedidoStatus/Cancelar
Esse POST cancela (remove) um pedido caso ele ainda não tenha sido liberado ou troca o status do pedido para cancelado (dependendo das configurações) caso ele já tenha sido liberaod.
Parâmetro controle do pedido deve ser numérico
Parâmetro observacao do status (Opcional)
curl --location --request GET 'http://focoalternativo.compumate.com.br/apiv1/pedidostatus/cancelar?controle=[CONTROLE_PEDIDO]&observacao=[TEXTO_OBSERVAÇÃO_OPCIONAL]' \
--header 'Authorization: Bearer [TOKEN GERADO NA ETAPA REQUEST TOKEN]'