CISS Command Center Api - Documentação das APIs do CCC (1.0)

Download OpenAPI specification:Download

Dispositivo

CCC - APIs de iteração com dispositivos

Gerar código

Gera e disponibiliza um código de ativação do dispositivo no CCC.

Authorizations:

BearerAuth

header Parameters

Accept required	string application/json
Content Type required	string application/json

Request Body schema: application/json

identificador required	string [ 1 .. 100 ] characters Identificador do dispositivo
tipoIntegracao required	string (TipoIntegracao) [ 1 .. 50 ] characters Enum: "CISS_LIVE_PDV" "CISS_LIVE_PDV_TOUCH" "CISS_FLY" "CISS_LIVE_SCAN" "CISS_TOTEM" "CISS_POS" "CISS_LIVE_SELF_CHECKOUT" Tipo de integração com o CCC
cnpj	string or null [ 1 .. 50 ] characters CNPJ do cliente Obs.: Necessário quando o dispositivo já está em uso
tipoErp	string (TipoErp) [ 1 .. 50 ] characters Enum: "CISS_LIVE" "CISS_PODER" Tipo de ERP configurado no dispositivo Obs.: Necessário quando informar CNPJ

Responses

Request samples

Payload

Content type

application/json

{"identificador": "123.456.789-0001",
"tipoIntegracao": "CISS_FLY",
"cnpj": "12345678901234",
"tipoErp": "CISS_LIVE"
}

Response samples

200
400
500

Content type

application/json

{"chaveAtivacao": "0E4R3O2S6",
"exp": 1659151307775,
"segundosExpiracao": 360
}

Registrar

Gera o token de acesso ao CCC após o registro do dispositivo.

Authorizations:

BearerAuth

header Parameters

Accept required	string application/json
Content Type required	string application/json

Request Body schema: application/json

chaveAtivacao required	string [ 1 .. 20 ] characters Chave de ativação gerada
identificador required	string [ 1 .. 100 ] characters Identificador do dispositivo
tipoIntegracao required	string (TipoIntegracao) [ 1 .. 50 ] characters Enum: "CISS_LIVE_PDV" "CISS_LIVE_PDV_TOUCH" "CISS_FLY" "CISS_LIVE_SCAN" "CISS_TOTEM" "CISS_POS" "CISS_LIVE_SELF_CHECKOUT" Tipo de integração com o CCC

Responses

Request samples

Payload

Content type

application/json

{"chaveAtivacao": "0E4R3O2S6",
"identificador": "123.456.789-0001",
"tipoIntegracao": "CISS_FLY"
}

Response samples

200
204
400
500

Content type

application/json

{"authorization": "Bearer xxx.yyy.zzz"
}

Credenciais

Obtêm as credenciais do dispositivo.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"dados": {"identificacao": {"identificador": "123.456.789-0001",
"cnpj": "12345678901234"
},
"licenciamento": {"ativo": true,
"status": "IRREGULAR",
"licenciadoAte": "2022-08-01T10:00:00.000Z",
"licenciadoPara": "CLIENTE",
"tipoErp": "CISS_LIVE"
},
"permissoes": [{"tipo": "NOTA_FISCAL",
"status": "ATIVO"
}
],
"conexoes": [{"fornecedor": "CISS_LIVE",
"tipo": "TOKEN",
"authorization": "Bearer xxx.yyy.zzz",
"hostName": "https://int.qa.cisslive.com.br",
"servicoIntegracao": "MOVIMENTACAO_PODER/INTEGRIM"
}
]
},
"assinatura": "string"
}

Versão disponível

Verifica e retorna a atualização do APP do dispositivo.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"linkDownload": "https://url.servidor/atualizacao/versao.zip",
"tipoIntegracao": "CISS_LIVE_PDV",
"versao": "v123"
}

Identificador

Recupera informações do dispositivo pelo Token.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"dados": {"identificador": "123.456.789-0001",
"cnpj": "12345678901234"
},
"assinatura": "string"
}

Dispositivo / Configuração

CCC - APIs para bkp de configurações dos dispositivos

Configuração

Grava as configurações do dispositivo.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Request Body schema: application/json

identificador required	string [ 1 .. 100 ] characters Identificador do dispositivo
cnpj required	string [ 1 .. 50 ] characters CNPJ do cliente
numeroCaixa required	string [ 1 .. 50 ] characters Número do PDV do dispositivo
configuracao required	object Objeto genérico contendo as configurações

Responses

Request samples

Payload

Content type

application/json

{"identificador": "123.456.789-0001",
"cnpj": "12345678901234",
"numeroCaixa": "123",
"configuracao": [{"tipoConfiguracao": "IMPRESSORA",
"ipImpressora": "127.0.0.1",
"modelo": "abc123"
}
]
}

Response samples

200
204
400
401
500

Content type

application/json

{"identificador": "123.456.789-0001",
"cnpj": "12345678901234",
"numeroCaixa": "123",
"configuracao": [{"tipoConfiguracao": "IMPRESSORA",
"ipImpressora": "127.0.0.1",
"modelo": "abc123"
}
]
}

Configuração

Recupera as configurações do dispositivo.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"identificador": "123.456.789-0001",
"cnpj": "12345678901234",
"numeroCaixa": "123",
"configuracao": [{"tipoConfiguracao": "IMPRESSORA",
"ipImpressora": "127.0.0.1",
"modelo": "abc123"
}
]
}

Dispositivo / Informação

CCC - APIs para bkp de informações dos dispositivos

Informação

Grava informações dos dispositivos.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Request Body schema: application/json

identificador required	string [ 1 .. 100 ] characters Identificador do dispositivo
numeroCaixa required	string [ 1 .. 50 ] characters Número do PDV do dispositivo
versaoApp required	string [ 1 .. 50 ] characters Versão do APP do dispositivo
versaoSO required	string [ 1 .. 50 ] characters Versão do SO do dispositivo
versaoHardware	string (VersaoHardware) <= 50 characters Enum: "cissbox-rpi-r1" "cissbox-rpi-r2" "cissbox-rpi-r3" Versão do Hardware do dispositivo
dsModelo	string [ 2 .. 200 ] characters Modelo do dispositivo
dsAdquirente	string [ 2 .. 200 ] characters Adquirente do dispositivo

Responses

Request samples

Payload

Content type

application/json

{"identificador": "123.456.789-0001",
"numeroCaixa": "123",
"versaoApp": "v123",
"versaoSO": "2.5",
"versaoHardware": "cissbox-rpi-r2",
"dsModelo": "GPOS700",
"dsAdquirente": "REDE"
}

Response samples

200
400
401
500

Content type

application/json

{"identificador": "123.456.789-0001",
"numeroCaixa": "123",
"versaoApp": "v123",
"versaoSO": "2.5",
"versaoHardware": "cissbox-rpi-r2"
}

Informação

Recupera informações do dispositivo pelo Token.

Authorizations:

BearerAuth

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"dados": {"identificador": "123.456.789-0001",
"cnpj": "12345678901234",
"numeroCaixa": "123",
"versaoApp": "v123",
"versaoSO": "2.5",
"versaoHardware": "cissbox-rpi-r2"
},
"assinatura": "string"
}

Cliente

CCC - APIs para consulta de dados de clientes

Find By CNPJ

Busca os dados de um cliente e sua organização pelo seu CNPJ.

Authorizations:

BearerAuth

path Parameters

cnpj

required

string

Example: 123456789000123

CNPJ do cliente

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"idCliente": 12345,
"dsRazaoSocial": "LOJA - ME",
"dsNomeFantasia": "Loja de tintas ABC",
"nrCnpj": "12345678901234",
"fgAtivo": true,
"idOrganizacao": 123,
"dsOrganizacao": "Lojas Unidas"
}

Configuracão responsável técnico DFE

CCC - APIs para consulta das configurações dos responsáveis técnicos DFE.

Recupera configuração do responsável técnico DFE

Este endpoint retorna a configuração do responsável técnico para o Documento Fiscal Eletrônico (DFE), incluindo datas de início de vigência e a lista de responsáveis associados.

query Parameters

nrCnpj required	string Example: nrCnpj=34453865000125 CNPJ do cliente
sgUf required	string Example: sgUf=PR Sigla da unidade federativa (UF) do cliente
tpAmbiente required	string Enum: "PRODUCAO" "HOMOLOGACAO" Example: tpAmbiente=PRODUCAO Tipo de ambiente (Produção, Homologação)
fgAtivo	string Default: "true" Enum: "true" "false" "both" Filtra responsáveis ativos. Use "both" para todos.

header Parameters

Authorization required	string Token de acesso à API.
Accept required	string application/json
Content Type required	string application/json

Responses

Response samples

200
204
401
500

Content type

application/json

{"data": {"dtInicioVigenciaNfe": "2025-01-01",
"dtInicioVigenciaNfce": "2025-04-01",
"responsaveis": [{"nrCnpj": "34453865000125",
"dsContato": "CISS S.A | Gestão para o Varejo",
"dsEmail": "ciss@ciss.com.br",
"nrTelefone": "4635363500",
"fgPrincipal": true,
"idCsrt": 213,
"cdCsrt": "G8063VRTNDMO886SFNK5LDUDEI24XJ22YIdasda",
"fgAtivo": true
}
]
}
}