Ambiente para desenvolvedores
Estas informações poderão ser alterados sem aviso prévio
As requisições feitas na API de integração devem conter nos dados do cabeçalho os seguintes campos.
Parâmetros de envioParâmetro | Descrição |
Token | Token de acesso |
Customer | Nome da empresa |
Código 401 – Erro na autenticação
Códigos de retorno
STATUS | ERROR | MESSAGE |
400 | Bad Request | Campos enviados com valores inválidos ou ausêntes |
401 | Unauthorized | Problema com o Token utilizado |
404 | Not Found | O caminho/url não foi encontrado |
200 | Ok | Requisição processada com sucesso |
Obtem Token de acesso
url: https://api.cliksys.com.br/authorize
Parâmetros de envioParâmetro | Tipo | Valor | Descrição |
user | String | api | Nome do usuário de acesso |
pass | String | 123 | Senha para o usuário de acesso |
Código 200 – OK
Obtem lista de pedidos
url: https://api.cliksys.com.br/orders
Parâmetros de envioParâmetro | Tipo | Valor | Descrição |
startDate | date | 2021-01-27 | Data inicial, se enviado em branco e caso flag for 0 retorna todos os não confirmados, senão se flag for 1 retorna da data atual |
endDate | date | 2021-01-27 | Data final, se enviado em branco e caso flag for 0 retorna todos os não confirmados, senão se flag for 1 retorna da data atual |
flag | Int | 0 | 0 = Retorna vendas não confirmadas 1 = Retorna as vendas já confirmadas Se enviar em branco ou não enviar retorna ambas as vendas. |
Código 200 – OK
Obtem o pedido
url: https://api.cliksys.com.br/order/orderId
Sem parâmetros de envioCódigo 200 – OK
Confirma o recebimento do pedido
url: https://api.cliksys.com.br/order/orderId/confirm
Sem parâmetros de envioCódigo 200 – OK
Confirma a impressão do pedido
url: https://api.cliksys.com.br/order/orderId/printing
Sem parâmetros de envioCódigo 200 – OK
Cancelar pedido
url: https://api.cliksys.com.br/order/orderId/cancel
Sem parâmetros de envioCódigo 200 – OK
Liberar o pedido online
url: https://api.cliksys.com.br/online
Sem parâmetros de envioCódigo 200 – OK
Confirmar cadastro do cliente
url: https://api.cliksys.com.br/customer/customerId/confirm
Sem parâmetros de envioCódigo 200 – OK
Atualiza Code PDV cadastro do cliente
url: https://api.cliksys.com.br/customer/customerId/code/customerCode
Sem parâmetros de envioCódigo 200 – OK
Confirmar cadastro do endereço do cliente
url: https://api.cliksys.com.br/customer/customerId/address/addressId/confirm
Sem parâmetros de envioCódigo 200 – OK
Altera o Preço do produto
url: https://api.cliksys.com.br/product/price
Parâmetros de envioParâmetro | Tipo | Valor | Descrição |
id | Int | 123 | ID do produto (opcional ID/CODE) |
code | String | 123 | Code PDV do produto (opcional ID/CODE) |
price | double | 0.01 | Valor novo para produto maior que 0,00 |
Código 200 – OK
Altera o Status do produto
url: https://api.cliksys.com.br/produtct/productId/status
Parâmetros de envioParâmetro | Tipo | Valor | Descrição |
status | String | AVAILABLE | O valor para status do produto AVAILABLE ou UNAVAILABLE |
Código 200 – OK