Neste post será descrito como utilizar as rotas HTTP  disponibilizadas para o cadastro e consulta dos grupos e empresas, atualização de certificado digital e alteração dos dados da empresa ,   nos anexos deste é possível realizar o download da aplicação em C#.

Para ser possível realizar a comunicação, primeiramente é necessário gerar o token que será necessário na autenticação da comunicação para o cadastro de grupos/empresas e na atualização de certificados, o mesmo é válido por 3 horas. Para isso, você deve realizar uma requisição do tipo POST na rota a seguir:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/software-house/token   

Onde será informado como parâmetro, no body da requisição, o email e a senha da Software House, assim como o parâmetro gerar =1, como na imagem a seguir:

O retorno será o token e a data de expiração do mesmo:

 
  {
    "mensagem": "Token gerado com sucesso",
    "dados": {
        "token": "6zl7aiaxfdhen4s4i1514552593339",
        "tokenexpiracao": "2017-12-29T14:03:13.000Z"
    }
}   

CADASTRO DE GRUPO

Para realizar o cadastro do grupo é necessário utilizar a rota a seguir, enviando uma requisição do tipo POST, utilizando o Token obtido no procedimento anterior:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/grupo?token=Token gerado pela Rota software-house/token   

Os parâmetros informados serão a Identificação que é o nome do grupo, a descrição, usuário e senha para o acesso à área restrita, como na imagem:

Caso o certificado seja do grupo inteiro o mesmo pode ser informado como parâmetro juntamente com a senha.

O retorno apresentará a mensagem de sucesso, ou não, no cadastro, além da confirmação das informações cadastradas

 
  {
    "mensagem": "Cadastro efetuado com sucesso",
    "dados": {
        "identificacao": "Grupo-TesteAPISH",
        "descricao": "teste tecno",
        "idusuario": 4586,
        "handle": 3425,
        "idsoftwarehouse": 6,
        "criadoem": "2017-12-29T11:25:38.000Z",
        "atualizadoem": "2017-12-29T11:25:38.869Z"
    }
}   

CADASTRO DE EMPRESA

Para realizar o cadastro de empresa, primeiro é necessário ter obtido o token e ter cadastrado o grupo no qual a empresa será criada, assim como ter o handle do mesmo, após é necessário realizar uma requisição POST na rota abaixo, lembrando que será necessário informar o token:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/empresa?token=6zl7aiaxfdhen4s4i1514552593339   

Os parâmetros se dividem em três grupos:

  • informações do grupo :o handle do grupo será informado no parâmetro idgrupo, em idUF o código da UF e o código da cidade ( para as emissões de NFSe) ;
  • informações da empresa :deve-se informar a situação (0=Ativo ou 1=Bloqueado), o CNPJ, Razão Social, Identificação, Descrição, Inscrição Estadual, Inscrição Municipal, endereço, telefone certificado ;
  • informações para a liberação de licença : para a liberação de licensa tem que se informar o documento e a situação do contrato, por exemplo nfce[situacao] =1 e nfce[tipocontrato]=1, onde:
    • Tipo de Contrato pode ser Bilhetagem=0 ou Ilimitado=1;
    • Situação pode ser Ativo=0 ou Inativo=1.

Não é necessário informar todos os documentos como no exemplo do Postman.

O retorno da requisição será no formato a seguir: 

 
  {
    "mensagem": "Cadastro efetuado com sucesso",
    "dados": {
        "handle": 5449,
        "idgrupo": 3425,
        "cnpj": "60642435000161",
        "identificacao": "testeapi",
        "descricao": "testeapi",
        "certificado": null,
        "iduf": 21,
        "idcidade": 4120,
        "inscricaomunicipal": "12345",
        "inscricaoestadual": "12345",
        "tipocertificado": "CURRENT_USER_STORE",
        "pincode": null,
        "razaosocial": "testeapi",
        "endereco": "Av. TesteAPI",
        "telefone": "4433000033",
        "email": null,
        "criadoem": "2017-12-29T14:22:25.000Z",
        "atualizadoem": "2017-12-29T14:22:25.000Z",
        "standby": null,
        "nfe": false,
        "nfce": false,
        "mdfe": false,
        "cte": false,
        "nfse": false,
        "cfesat": false,
        "situacao": 0,
        "gnre": false,
        "datainativacao": null,
        "motivo": null,
        "dtentradastandby": null,
        "dtsaidastandby": null,
        "dtvencimentocertificado": null,
        "hashcertificado": null,
        "cteos": false
    }
}   

ALTERAR DADOS DA EMPRESA

Os dados que foram cadastrados podem ser alterados por meio de uma requisição PUT, na rota a seguir, na qual será informado o handle da empresa como parte da URL (no exemplo, 5449):

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/empresa/5449?token=6zg9mjudrqe86ko6r1514568674381   

Os dados da empresa que serão alterados devem ser passados como parâmetro no body da requisição, exemplo:

O retorno trará todos os dados da empresa, incluindo os alterados, por exemplo:

 
  {
    "mensagem": "Cadastro atualizado com sucesso",
    "dados": {
        "handle": 5449,
        "idgrupo": 3425,
        "iduf": 21,
        "idcidade": 4120,
        "cnpj": "60642435000161",
        "identificacao": "testeapi",
        "descricao": "testeapi",
        "certificado": null,
        "inscricaomunicipal": "12345",
        "inscricaoestadual": "12345",
        "tipocertificado": "CURRENT_USER_STORE",
        "pincode": null,
        "razaosocial": "testeapi",
        "endereco": "Av. TesteAPI",
        "telefone": "4433000033",
        "email": null,
        "criadoem": "2017-12-29T14:22:25.000Z",
        "atualizadoem": "2017-12-29T18:06:47.000Z",
        "nfe": false,
        "nfce": false,
        "mdfe": false,
        "cte": false,
        "nfse": false,
        "cfesat": false,
        "gnre": false,
        "cteos": false,
        "situacao": 0,
        "datainativacao": null,
        "motivo": null,
        "hashcertificado": null,
        "dtvencimentocertificado": null
    }
}   


CONSULTAR GRUPOS CADASTRADOS

Para consultar os grupos cadastrados, é necessário enviar uma requisição do tipo GET, na rota:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/grupo?token=6zg9mjudrqe86ko6r1514568674381&skip=0&limit=10&sort=identificacao   

 O retorno trará todos os grupos cadastrados na Software House, exemplo:

 
  {
    "mensagem": "Registros retornados com sucesso",
    "dados": [
        {
            "handle": 3291,
            "identificacao": "grupo-teste",
            "descricao": "grupo-teste",
            "idsoftwarehouse": 6,
            "idusuario": 4374,
            "criadoem": "2017-12-08T18:36:50.000Z",
            "atualizadoem": "2017-12-08T18:36:50.000Z"
        },
        {
            "handle": 3255,
            "identificacao": "testenfce",
            "descricao": "testenfce",
            "idsoftwarehouse": 6,
            "idusuario": 4329,
            "criadoem": "2017-12-01T19:25:16.000Z",
            "atualizadoem": "2017-12-01T19:25:16.000Z"
        }
    ],
    "total": 2
}   

CONSULTAR EMPRESAS CADASTRADAS

Para realizar a consulta das empresas cadastradas é necessário informar o Token e o id do grupo (que é o handle recebido na consulta anterior), e enviar a seguinte requisição GET:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/empresa?token=6zg9mjudrqe86ko6r1514568674381&idgrupo=3425&skip=0&limit=10&sort=identificacao   

O retorno trará todas as empresas cadastradas e as informações das mesmas, como por exemplo:

 
  {
    "mensagem": "Registros retornados com sucesso",
    "dados": [
        {
            "handle": 5449,
            "idgrupo": 3425,
            "iduf": 21,
            "idcidade": 4120,
            "cnpj": "60642435000161",
            "identificacao": "testeapi",
            "descricao": "testeapi",
            "certificado": null,
            "inscricaomunicipal": "12345",
            "inscricaoestadual": "12345",
            "tipocertificado": "CURRENT_USER_STORE",
            "pincode": null,
            "razaosocial": "testeapi",
            "endereco": "Av. TesteAPI",
            "telefone": "4433000033",
            "email": null,
            "criadoem": "2017-12-29T14:22:25.000Z",
            "atualizadoem": "2017-12-29T14:22:25.000Z",
            "nfe": false,
            "nfce": false,
            "mdfe": false,
            "cte": false,
            "nfse": false,
            "cfesat": false,
            "gnre": false,
            "cteos": false,
            "situacao": 0,
            "datainativacao": null,
            "motivo": null,
            "hashcertificado": null,
            "dtvencimentocertificado": null
        }
    ],
    "total": 1
}   

LISTAR UF E CIDADES

Para listar as UFs com o código da UF, sigla e descrição, basta enviar uma requisição GET na rota:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/uf?token=6zg9mjudrqe86ko6r1514568674381   

Para listar as cidades com o código da UF e o código do IBGE, basta enviar uma requisição GET na rota:

 
  https://managersaas.tecnospeed.com.br:1337/api/v1/cidade?token=6zg9mjudrqe86ko6r1514568674381   

 

Arquivos para download