Comparação de Páginas

...

Para acessar a documentação com instruções de como utilizar a API utilize o link API Wake OMS no seu navegador.

Para utilizar a API, será necessário usuário e senha habilitados para essa funcionalidade. A seguir, algumas demonstrações de como testar os endpoints da API no site da documentação.

Autenticando o usuário e senha

...

, será necessário atualizar o domínio da URL

...

O campo para atualização do domínio encontra-se no canto superior direito da tela.

2. Role a tela para baixo até a seção BODY PARAMS e preencha os campos usuário e senha.

3. No lado direito da tela, seção CURL REQUEST, pressione o botão “Try it” para proceder com a requisição de autenticação.

4. Na seção RESPONSE, localizada do lado direito, é possível obter os dados de retorno. Caso a requisição tenha sido realizada com sucesso (código 200), copie o código impresso no campo token para utilizá-lo em outros endpoints de API

Comentários:

⇨  Será retornado um token com validade de 1 hora e um refresh token com validade de 7 dias. O token deve ser usado em todas as requisições, o renovar token deve ser usado no endpoint "renovar-token" quando o token expirado, para obter um novo token válido por mais uma hora.

⇨  O usuário e senha para acesso à API é o mesmo utilizado para acessar o Wake OMS Web e App, porém o acesso a API deverá ser habilitado nos parâmetros da conta. Caso já possua uma conta e gostaria de utilizar a API, solicite ao suporte o acesso a funcionalidadee preencher os campos de usuário e senha conforme demonstrado no link https://sintesesolucoes.atlassian.net/wiki/x/CYAAB.

A seguir, algumas demonstrações de como testar os endpoints Contas e Permissões da Conta no site da documentação.

...

Incluir Conta

1. Para incluir uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Incluir Conta, configurado com um endpoint do tipo POST.

2. Cole o token gerado no endpoint de autenticação no campo AUTHORIZATION localizado no canto superior direito.

...

3. Role a página até a seção BODY PARAMS, onde estarão os campos necessários para cadastro da conta.

Comentários:

⇨  Atentar-se para os campos destacados pela palavra em vermelho “required”, tratam-se de campos obrigatórios na requisição.

4. Após preencher os campos, vá até a seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

5. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso.

...

1. Para consultar uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Consultar Conta configurada com um endpoint do tipo GET.

2. Caso já tenha utilizado o endpoint Incluir Conta, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Role a página até a seção QUERY PARAMS, nesta seção estão os parâmetros possíveis para filtrar a consulta.

4. Após preencher os campos, vá até a seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

5. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso.

Comentários:

⇨  Os parâmetros de busca não são obrigatórios. Caso não sejam utilizados, a requisição listará todos os resultados possíveis no limite de 50 por página.

⇨  Caso o parâmetro “pagina” não seja informado, o valor padrão será 1.

...

Atualizar Conta

1. Para atualizar uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Atualizar Conta configurada com um endpoint do tipo INPUT;

2. Caso já tenha utilizado o endpoint Incluir Conta ou Consultar Conta, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Role a página até a seção BODY PARAMS, nesta seção estão os parâmetros passíveis de atualização;

4. Observe que o parâmetro “conta” é obrigatório;

5. Após preencher os campos, vá até a seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

6. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso.

Comentários:

⇨  Se alguma propriedade for omitida, será atribuído valor nulo ao campo correspondente. Para evitar atribuições nulas indesejadas, é recomendável enviar o objeto com todas as suas propriedades e valores de forma explícita.

...

Listar Permissões

1. Para listar as permissões possíveis para a conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Permissões da Conta, subseção ‘Listar Permissões’ configurada com endpoint do tipo GET;

2. Caso já tenha utilizado qualquer outro endpoint Incluir antes desde, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Vá até a seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

4. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada e a lista de permissão será listada.

Comentários:

⇨  O campo idAcao deverá ser utilizado nos endpoints Incluir Permissão da Conta e Excluir Permissões da Conta.

...

Incluir Permissões da Conta

...

1. Para incluir permissões em uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Permissões da Conta, subseção ‘Incluir Permissões da Conta’ configurada com endpoint do tipo POST;

2. Caso já tenha utilizado qualquer outro endpoint Incluir antes desde, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Role a página até a seção BODY PARAMS, nesta seção estão os parâmetros necessários para realizar a inclusão;

4. Após preencher os campos, vá até a seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

5. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso e a nova permissão foi incluída.

...

1. Para consultar as permissões em uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Permissões da Conta, subseção ‘Consultar Permissões da Conta’ configurada com endpoint do tipo GET;

2. Caso já tenha utilizado qualquer outro endpoint Incluir antes desde, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Role a página até a seção QUERY PARAMS, nesta seção estará o parâmetro necessário para realizar a requisição.

4. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso e a lista de permissões da conta foram listadas.

...

1. Para excluir as permissões em uma conta, vá até a seção Contas localizada do lado esquerdo da página, subseção Permissões da Conta, subseção ‘Excluir Permissões’ configurada com endpoint do tipo DELETE;

2. Caso já tenha utilizado qualquer outro endpoint Incluir antes desde, o token de autenticação estará preenchido no seu respectivo campo. Caso ainda não tenha utilizado, siga os passos descritos neste documento no item Incluir Conta parágrafo 2.

3. Role a página até a seção BODY PARAMS, nesta seção estão os parâmetros necessários para realizar a exclusão;

4. Após preencher os campos, vá até a  seção CURL REQUEST localizada no lado direito da página, pressione o botão “Try it” para proceder com a requisição de inclusão da conta.

5. Caso retorne o valor 200 na seção RESPONSE, significa que a requisição foi realizada com sucesso e a lista de permissões da conta foi excluída.