Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Para consultar quais são os códigos dos departamentos do seu sistema, utilize o seguinte método: ListarDepartamentos
Para incluir um departamento, vamos utilizar o seguinte método: Incluir Departamento
Um erro muito comum, é quando utilizamos a requisição abaixo:
Isso acontece, pois o código que o sistema espera, é o departamento pai. Vamos pegar como exemplo essa estrutura:
Caso queira cadastrar um departamento filho, do departamento destacado, o correto seria informar o código do departamento "Administrativo", e a descrição do novo departamento, exemplo:
# REQUEST
{
"descricao": "Departamento Filho do Administração - Descrição",
"codigo": "7311798890"
}
# RESPONSE
{
"codigo": "000007315696207",
"descricao": "",
"cCodStatus": "0",
"cDesStatus": "Departamento adicionado com sucesso!",
"estrutura": "001.001.001"
}
Agora, caso seja para criar um departamento que fique na mesma linha desse em destaque, o correto seria informar o código do departamento pai:
Exemplo:
# REQUEST
{
"descricao": "Equipe de TI",
"codigo": "7311798892"
}
# RESPONSE
{
"codigo": "000007315696762",
"descricao": "", "cCodStatus": "0",
"cDesStatus": "Departamento adicionado com sucesso!",
"estrutura": "001.004"
}
📌 Separamos alguns artigos interessantes para você:
