Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

v1.12

Serviço para atualização das informações cadastrais de uma aplicação.

...

Demonstração: https://demo-certificado.vidaas.com.br

1.

...

Solicitar token de acesso

Antes de chamar o endpoint de manutenção poder chamar alguns endpoints é necessário solicitar um access_token conforme detalhado a seguir.
Observação: uma aplicação não poderá ser excluída (ver item 4 deste manual) caso tenha um token de acesso emitido em seu nome.

  • Path : <URI-base>/v0/oauth/client_token

  • Verbo HTTP: POST

  • Cabeçalho

    • Content-type: application/x-www-form-urlencoded ;

  • Corpo da requisição no formato "application/x-www-form-urlencoded"

    • grant_type: obrigatório, valor "client_credentials"

    • client_id: obrigatório, deve conter a identificação da aplicação

    • client_secret: obrigatório, deve conter a senha da aplicação

...

  • Exemplo de requisição e resposta com o access_token e sua validade (expires_in, em segundos)

...

2.

...

Alterar dados da aplicação

Na posse de um access_token válido é possível então efetuar as mudanças nos dados da aplicação conforme detalhado a seguir.

  • Path: <URI-base>/v0/oauth/client_maintenance

  • Verbo HTTP: PUT

  • Cabeçalho

    • Content-type: application/json

    • Accept: application/json

    • Authorization: Bearer access_ token (“Bearer” concatenado com espaço em branco e o
      access_token)

  • Corpo da requisição no formato "application/json;charset=UTF-8"

    • client_id: obrigatório, deve conter a identificação da aplicação

    • client_secret: opcional, caso informado será a nova a senha da aplicação

    • name: opcional, caso informado será o novo nome da aplicação

    • comments: opcional, caso informado será o novo descritivo da aplicação

    • redirect_uris: opcional, novas URI’s autorizadas para redirecionamento (para requisição de
      código de autorização)

    • email: obrigatório, contato para suporte em caso de indisponibilidade, mudança de
      versão, entre outros

  • Exemplo de requisição e resposta com o access_token e sua validade (expires_in, em segundos)

    Image Removed

...

    • type: opcional, caso informado será o novo tipo da aplicação. Os valores possíveis são

      • common

      • sharing

Image AddedImage Added

3. Consultar dados da aplicação

Na posse de um access_token válido também é possível consultar os dados da aplicação conforme detalhado a seguir.

  • Path: <URI-base>/v0/oauth/application/{client_id}

  • Verbo HTTP: GET

  • Cabeçalho

    • Content-type: application/json

    • Accept: application/json

    • Authorization: Bearer token (“Bearer” concatenado com espaço em branco e o
      access_token)

...

Requisição e resposta

4. Remover dados da aplicação

Antes de chamar o endpoint de delete é necessário ter conhecimento que uma aplicação não pode ser removida se tiver qualquer token emitido em seu nome.

  • Path: <URI-base>/v0/oauth/application/{client_id}

  • Verbo HTTP: DELETE

  • Cabeçalho

    • Content-type: application/json

  • Corpo da requisição no formato "application/json;charset=UTF-8"

    • client_secret: obrigatório, deve conter a senha da aplicação

...

Requisição e resposta