Skip to content

Latest commit

 

History

History
281 lines (224 loc) · 7.05 KB

Uso.md

File metadata and controls

281 lines (224 loc) · 7.05 KB
Raw

Passo a passo para usar o Fiscalidade Server

Os passos a seguir explicam usar o Fiscalidade Server a partir de serviço ou compilando o executável com o Cargo.

As seguintes ferramentas serão utilizadas:

Compilando e executando o Fiscalidade Server

IMPORTANTE: Certifique-se do PostgreSQL estar instalado! Em seguida, compile e execute o Fiscalidade Server que ele se encarregará de criar as tabelas no banco de dados automaticamente. O comando mínimo para compilá-lo e executá-lo é:

cargo run --release -- \
    -p 8080 \
    -d postgres://postgres:[email protected]/postgres

Explicando os parâmetros do comando acima:

  • -p 8080 - Porta do servidor. Onde a API será disponibilizada, ex: http://localhost:8080/fiscalidade/v1/taxpayers/services.
  • -d postgres://postgres:[email protected]/postgres - Caminho (path) para o banco de dados. Neste caso, usando o DB padrão disponível no Docker, postgres.

Para mais informações, use o menu de ajuda da aplicação: cargo run --release -- -h.

Executando o Fiscalidade Server via serviço/daemon

Todas as instruções para executar o Fiscalidade Server como serviço no Windows ou daemon no Linux estão disponíveis em docs/Instalação.md.

Definindo administrador padrão do servidor

Antes de prosseguir com os próximos passos, verifique se o servidor está online. Para isto, basta consultar sua versão com o seguinte comando:

curl -s \
    http://localhost:8080/fiscalidade/v1/version | jsonpp

ele deve retornar um JSON com a versão do servidor, exemplo:

{
  "status": "ok",
  "result": {
    "major": 0,
    "minor": 6,
    "patch": 2
  }
}

feito isso, agora podemos definir um administrador para gerenciamento do servidor:

curl -s \
    -X POST http://localhost:8080/fiscalidade/v1/taxpayers/manager | jsonpp

administrador criado:

{
  "status": "ok",
  "result": {
    "id": 1,
    "name": "admin",
    "business_name": "Administrador",
    "registry": "",
    "email": "",
    "certificate": "",
    "certificate_password": "",
    "token": "qoNrF2mZsSUpZCEXUw2Mxx",
    "manager": true,
    "active": true,
    "created_at": "2020-02-24T15:44:37.210486"
  }
}

Observe o token gerado: qoNrF2mZsSUpZCEXUw2Mxx. Guarde ele em um local seguro! Este será o token do administrador padrão do servidor. Usaremos ele nos passos a seguir.

Cadastrando contribuinte / solicitando uso de serviço

Considerando que o certificado do contribuinte encontra-se em ~/Downloads/certificado.pfx:

curl -s \
    -X POST \
    -H 'Content-Type: application/json' \
    -d '{"name":"Fulano","business_name":"Fulano de tal","registry":"123456789","email":"fulano@gmail","certificate":"'$(base64 -w 0 $HOME/Downloads/certificado.pfx)'","certificate_password":"12345678"}' \
    http://localhost:8080/fiscalidade/v1/taxpayers | jsonpp

o servidor deve retornar o seguinte JSON:

{
  "status": "ok",
  "result": {
    "id": 2,
    "name": "Fulano",
    "business_name": "Fulano de tal",
    "registry": "123456789",
    "email": "fulano@gmail",
    "certificate": "MIIkEAIB...<demais caracteres>=",
    "certificate_password": "12345678",
    "token": "U8pNjWuAdj2PB3AGnai7mT",
    "manager": false,
    "active": true,
    "created_at": "2020-02-24T15:47:03.824520"
  }
}

agora, com o contribuinte cadastrado, podemos fazer uma solicitação de uso de serviço. Para consultar a lista de serviços disponíveis, use:

curl -s \
    http://localhost:8080/fiscalidade/v1/services | jsonpp

serviços listados:

{
  "status": "ok",
  "result": [
    {
      "id": 1,
      "description": "NF-e",
      "slug": "nfe",
      "active": true,
      "created_at": "2020-02-24T15:44:31.537942"
    }
  ]
}

por fim, solicitamos o uso do serviço NF-e para contribuinte cadastrado:

curl -s \
    -X POST \
    -H 'X-Auth-Token: U8pNjWuAdj2PB3AGnai7mT' \
    -H 'Content-Type: application/json' \
    -d '{"taxpayer_id":2,"service_id":1}' \
    http://localhost:8080/fiscalidade/v1/taxpayers/services | jsonpp

solicitação criada:

{
  "status": "ok",
  "result": {
    "id": 1,
    "taxpayer_id": 2,
    "service_id": 1,
    "allowed_at": null,
    "created_at": "2020-02-24T15:49:36.359227"
  }
}

Autorizando uso de serviço

A listagem de serviços solicitados pode ser acessada por qualquer usuário administrador. Neste exemplo, usaremos o administrador padrão, que foi cadastrado com o token qoNrF2mZsSUpZCEXUw2Mxx.

Listando serviços solicitados:

curl -s \
    -H 'X-Auth-Token: qoNrF2mZsSUpZCEXUw2Mxx' \
    http://localhost:8080/fiscalidade/v1/taxpayers/services/unauthorized | jsonpp

solicitações listadas:

{
  "status": "ok",
  "result": [
    {
      "id": 1,
      "taxpayer_id": 2,
      "taxpayer_name": "Fulano",
      "service_id": 1,
      "service_description": "NF-e",
      "allowed_at": null,
      "created_at": "2020-02-24T15:49:36.359227"
    }
  ]
}

por fim, basta autorizar uso de serviço "NF-e" para contribuinte "Fulano":

curl -s \
    -X POST \
    -H 'X-Auth-Token: qoNrF2mZsSUpZCEXUw2Mxx' \
    -H 'Content-Type: application/json' \
    http://localhost:8080/fiscalidade/v1/taxpayers/services/authorize/1 | jsonpp

autorização criada:

{
  "status": "ok",
  "result": {
    "id": 1,
    "taxpayer_id": 2,
    "service_id": 1,
    "allowed_at": "2020-02-24T15:50:59.319443",
    "created_at": "2020-02-24T15:49:36.359227"
  }
}

e finalmente o contribuinte tem permissão para acessar o serviço:

curl -s \
    -H 'X-Auth-Token: U8pNjWuAdj2PB3AGnai7mT' \
    http://localhost:8080/fiscalidade/v1/nfe/status-servico/mt/p | jsonpp

resultado:

{
  "status": "ok",
  "result": "<?xml version='1.0' encoding='utf-8'?><soapenv:Envelope xmlns:soapenv=\"http://www.w3.org/2003/05/soap-envelope\"><soapenv:Body><nfeResultMsg xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeStatusServico4\"><retConsStatServ xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"><tpAmb>1</tpAmb><verAplic>MT_A2RL-4.00</verAplic><cStat>109</cStat><xMotivo>Servico Paralisado sem Previsao</xMotivo><cUF>51</cUF></retConsStatServ></nfeResultMsg></soapenv:Body></soapenv:Envelope>"
}

Desautorizando uso de serviço

Se por alguma razão for necessário remover autorização de uso de serviço para contribuinte, use:

curl -s \
    -X PUT \
    -H 'X-Auth-Token: qoNrF2mZsSUpZCEXUw2Mxx' \
    -H 'Content-Type: application/json' \
    http://localhost:8080/fiscalidade/v1/taxpayers/services/unauthorize/1 | jsonpp

resultado:

{
  "status": "ok",
  "result": {
    "id": 1,
    "taxpayer_id": 2,
    "service_id": 1,
    "allowed_at": null,
    "created_at": "2020-02-24T15:49:36.359227"
  }
}

e ao tentar acessar o serviço novamente:

curl -s \
    -H 'X-Auth-Token: U8pNjWuAdj2PB3AGnai7mT' \
    http://localhost:8080/fiscalidade/v1/nfe/status-servico/mt/p | jsonpp

o acesso é negado:

{
  "status": "error",
  "reason": "Unauthorized"
}