Neste post se explicará 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 saber como gerenciar Empresas via API, consulte este artigo.
Atenção!
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:
POST
https://managersaas.tecnospeed.com.br:1337/api/v1/software-house/token
Body
No body da requisição poderão ser utilizados os seguintes parâmetros:
| Nome | Descrição |
| E-mail do login da Software House. | |
| senha | Senha da Software House. |
| gerar |
Indica a API que o token deve ser gerado. Valores: 1 - Gerar um novo Token. 0 - Não gerar. |
| api |
Indica a API qual tipo de token será gerado. Vales: 1 - Indica que o token da API deve ser gerado. Esse token não possui data de expiração. 0 - Indica que o token gerado possui data de expiração. |
Retorno
O retorno poderá ser de duas formas:
- O token e a data de expiração do mesmo ( api = 0):
{
"mensagem": "Token gerado com sucesso",
"dados": {
"token": "6zl7aiaxfdhen4s4i1514552593339",
"tokenexpiracao": "2017-12-29T14:03:13.000Z"
}
}
- Somente o token ( api = 1).
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:
POST
https://managersaas.tecnospeed.com.br:1337/api/v1/grupo?token=Token gerado pela Rota software-house/token
Body
No body da requisição poderão ser utilizados os seguintes parâmetros:
| Nome | Descrição |
| identificacao | Identificador do grupo. |
| descricao | Descrição do grupo. |
| senha | Senha para o grupo.
|
| confirmacaoSenha | Confirmação da senha do grupo.
|
| usuario | Usuário do Manager SaaS. |
Caso o certificado seja do grupo inteiro, o mesmo pode ser informado como parâmetro juntamente com a senha.
| Nome | Descrição |
| certificadobinario | Arquivo binário do certificado digital. |
| senhacertificado | Senha do certificado digital. |
Atenção! Os parâmetros obrigatórios para o cadastro do grupo são:
- identificacao
- descricao
- senha
- confirmacaoSenha
- usuario
Retorno
No cadastro, o retorno apresentará a mensagem de sucesso ou não, 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"
}
}
Consultar grupos cadastrados
Para consultar os grupos cadastrados, é necessário enviar uma requisição do tipo GET, na rota:
GET
https://managersaas.tecnospeed.com.br:1337/api/v1/grupo?token=6zg9mjudrqe86ko6r1514568674381&skip=0&limit=10&sort=identificacao
Para trazer apenas um grupo em específico, é possível passar somente o Handle e o Token:
https://managersaas.tecnospeed.com.br:1337/api/v1/grupo?handle=544857&token=6zg9mjudrqe86ko6r1514568674381
Retorno
O retorno trará todos os grupos cadastrados na Software House. Por 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
}
Editar grupos cadastrados
Antes de iniciar este passo realize uma consulta para obter o handle do grupo que sofrerá a alteração. Para editar alguma informação dos grupos cadastrados, é necessário enviar uma requisição do tipo PUT.
PUT
https://managersaas.tecnospeed.com.br:1337/api/v1/grupo/{handle}?token=6zg9mjudrqe86ko6r1514568674381
Body
No body da requisição poderão ser utilizados os seguintes parâmetros:
| Nome | Descrição |
| identificacao | Identificador do grupo. |
| descricao | Descrição do grupo. |
Querystring
| Nome | Descrição |
| token | Token da Software House. |
Retorno
O retorno apresentará uma mensagem de sucesso ou erro, e listará as informações alteradas do grupo. Por exemplo:
{
"mensagem":"Cadastro atualizado com sucesso",
"dados":{
"identificacao":"Tecnospeed",
"descricao":"Tecnospeed"
}
}
Redefinir a senha do grupo
Antes de iniciar este passo realize uma consulta para obter o handle do grupo que sofrerá a alteração. Para editar alguma informação dos grupos cadastrados, é necessário enviar uma requisição do tipo PUT.
PUT
https://managersaas.tecnospeed.com.br:1337/api/v1/usuario?token=
Body
No body da requisição deverão ser utilizados os seguintes parâmetros:
| Nome | Descrição |
| idgrupo | Handle do Grupo que sofrerá a alteração. |
| usuario | Usuário do Manager SaaS. |
| senha | Senha atual do Grupo. |
| novaSenha | Nova senha (que passará a utilizar). |
| confirmacaoSenha |
Confirmação da nova senha (a mesma senha informada no campo novaSenha). |
Querystring
| Nome | Descrição |
| token | Token da Software House. |
Retorno
O retorno apresentará uma mensagem de sucesso ou erro, e listará as informações alteradas do grupo. Por exemplo:
{
"mensagem": "Cadastro atualizado com sucesso",
"dados": {
"handle": 123,
"idgrupo": 456,
"descricao": "Administrador",
"usuario": "admin",
"senha": "0C6890E4D85DA8B795FDAFDD5EFB22D1"
}
}
Listar UF's e cidades
Para listar as UF's com o código da UF, sigla e descrição, basta enviar uma requisição GET na rota:
GET
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:
GET
https://managersaas.tecnospeed.com.br:1337/api/v1/cidade?token=6zg9mjudrqe86ko6r1514568674381
Veja também o post: Gerenciando Empresas Via API
Comentários
0 comentário
Por favor, entre para comentar.