Acesso
Informações de acesso da API.
Método e URLs
Comunicação: REST/JSON
Para acessar a coleção de chamadas Clique Aqui.
Swagger Solicitação de Regras
https://api-diagnosticofiscal.systax.com.br/swagger/index.html?urls.primaryName=Api%20Solicita%C3%A7%C3%A3o%20de%20Regras
Listagem dos Endpoints que contemplam o manual de Solicitação de Regras
|
Descrição |
Versão |
Grupo Swagger |
Método |
URL Endpoint |
|---|---|---|---|---|
|
Solicitar Regras |
v1 |
SolicitacaoRegra |
Post |
http://api-diagnosticofiscal. systax.com.br/api/ solicitacao_regra |
|
Consultar Retorno de Regras |
v1 |
SolicitacaoRegra |
Get |
https://api-diagnosticofiscal. systax.com.br/api/solicitacao_regra/ {cliente_id}/{protocolo}/{offset}/ {quantity} |
- cliente_id: ID do cliente. Entre em contato com a Systax para obtê-lo;
- protocolo: Número de protocolo gerado pela API de solicitação de regras;
- offset: quantidade de registros exibidos;
- quantity: quantidade de registros á exibir;
Observação: Os parâmetros "offset" e "quantity" são usados para a paginação e serão detalhados o longo da documentação.
Autenticação
A autenticação nas API´s de solicitação e retorno de regras é feita via bearer token. Para mais informações sobre como gerá-lo, consultar a última versão do manual da API de geração de token.
Coleção de chamadas
{
"info": {
"_postman_id": "05c4a824-65e1-4163-a1ae-823e0e0aa157",
"name": "Api - Cálculo em Lote.v1",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "21298242"
},
"item": [
{
"name": "Gerar Token",
"item": [
{
"name": "Token",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "",
"type": "string"
},
{
"key": "username",
"value": "",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "http://app.systax.com.br/platform/access-token",
"protocol": "http",
"host": [
"app",
"systax",
"com",
"br"
],
"path": [
"platform",
"access-token"
]
}
},
"response": []
}
]
},
{
"name": "Solicitação de Regra",
"item": [
{
"name": "Teste 1",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"id_cliente\":\"\",\r\n \"produtoCenario\":[\r\n {\r\n \"produtos\":[\r\n {\r\n \"item\":null,\r\n \"codigo_produto\":null,\r\n \"origem_produto\":\"7\",\r\n \"ncm\":\"33030010\",\r\n \"ex_tipi\":null,\r\n \"ean\":\"\",\r\n \"descricao\":null,\r\n \"data_calculo\":\"09-05-2023\"\r\n }\r\n ],\r\n \"cenario\":{\r\n \"uf_origem\":\"SP\",\r\n \"uf_destino\":\"SP\",\r\n \"natureza_operacao\":\"121\",\r\n \"perfil_origem\":\"24,843\",\r\n \"perfil_destino\":\"140\",\r\n \"finalidade\":\"\",\r\n \"ent_sai\":\"1\",\r\n \"municipio_origem\":null,\r\n \"municipio_destino\":null\r\n } \r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://api-diagnosticofiscal.systax.com.br/api/solicitacao_regra",
"protocol": "http",
"host": [
"api-diagnosticofiscal",
"systax",
"com",
"br"
],
"path": [
"api",
"solicitacao_regra"
]
}
},
"response": []
},
{
"name": "Teste 2",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n\"id_cliente\":\"\",\r\n\"produtoCenario\":[\r\n{\r\n\"produtos\":[\r\n{\r\n\"item\":null,\r\n\"codigo_produto\":null,\r\n\"origem_produto\":\"0\",\r\n\"ncm\":\"40103900\",\r\n\"ex_tipi\":null,\r\n\"ean\":\"\",\r\n\"descricao\":null,\r\n\"data_calculo\":\"01/02/2022 00:00:00\"\r\n}\r\n],\r\n\"cenario\":{\r\n\"uf_origem\":\"MT\",\r\n\"uf_destino\":\"MT\",\r\n\"natureza_operacao\":\"121\",\r\n\"perfil_origem\":\"2\",\r\n\"perfil_destino\":\"46\",\r\n\"finalidade\":\"\",\r\n\"ent_sai\":\"1\",\r\n\"municipio_origem\":null,\r\n\"municipio_destino\":null\r\n }\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://api-diagnosticofiscal.systax.com.br/api/solicitacao_regra",
"protocol": "http",
"host": [
"api-diagnosticofiscal",
"systax",
"com",
"br"
],
"path": [
"api",
"solicitacao_regra"
]
}
},
"response": []
}
]
},
{
"name": "Retorno da Regra",
"item": [
{
"name": "Teste 1",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "http://api-diagnosticofiscal.systax.com.br/api/solicitacao_regra/IdCliente/Protocolo/offset/quantity",
"protocol": "http",
"host": [
"api-diagnosticofiscal",
"systax",
"com",
"br"
],
"path": [
"api",
"solicitacao_regra",
"IdCliente",
"Protocolo",
"offset",
"quantity"
]
}
},
"response": []
},
{
"name": "Teste 2",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "http://api-diagnosticofiscal.systax.com.br/api/solicitacao_regra/IdCliente/Protocolo/offset/quantity",
"protocol": "http",
"host": [
"api-diagnosticofiscal",
"systax",
"com",
"br"
],
"path": [
"api",
"solicitacao_regra",
"IdCliente",
"Protocolo",
"offset",
"quantity"
]
}
},
"response": []
}
]
}
]
}