Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest


Para a emissão de NFC-e, é necessário que seja informado o CSC referente à empresa e estado de emissão. Sem esta informação não é possível obter a autorização do cupom. É possível configurar estas informações na aplicação da Oobj através do monitor e da API. Abaixo instruções sobre como consultar e configurar utilizando as requisições da API da Oobj.

A utilização da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token.

 

Adicionar Novo CSC para a Empresa (POST)

Este Endpoint, é utilizado para configurar o CSC de emissão de uma empresa. Caso tenha mais de uma unidade e em estados diferentes é possível configurar todos através desta requisição.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/cscs/{uf}/{ambiente}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/cscs/GO/hom

 

Na requisição, deverá ser informado os seguintes dados:

 

Listar CSC disponível para Empresa (GET)

Este Endpoint, é utilizado para consultar o CSC de emissão disponível para a empresa. Caso tenha mais de uma CSC cadastrado, serão apresentados todos.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/cscs

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/cscs

 

Retornar detalhes do CSC (GET)

Este Endpoint, é utilizado para consultar um CSC de emissão específico de uma empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/cscs/{uf}/{ambiente}/{sequencial}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/cscs/GO/hom/1

 

Alterar informações do CSC (PUT)

Este Endpoint, é utilizado editar dados do CSC de emissão de uma empresa. 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/cscs/{uf}/{ambiente}/{sequencial}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/cscs/GO/hom/1

 

Na requisição, deverá ser informado os seguintes dados:

 

Excluir (DELETE)

Este Endpoint, é utilizado excluir os dados de um determinado  CSC de emissão de uma empresa, quando já não é mais utilizado. 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/cscs/{uf}/{ambiente}/{sequencial}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/cscs/GO/hom/1

 

Para realizar testes com a API Rest, e ter mais detalhes sobre a configuração de CSC, acesse a documentação completa através do link: http://rest.oobj-dfe.com.br/swagger-ui.html



Nº do Artigo: 750
Postado: 16/03/2018 10:26:42
Última atualização: 27/09/2021 12:00:26
Postado: Isabel Cavalcanti [isabel.cavalcanti@oobj.com.br]

URL: https://oobj.com.br/bc/article/manutenção-de-csc-código-de-segurança-do-contribuinte-na-api-rest-750.html