Documentação: Como Alterar Informações das Autoclaves no APP ?

Criada por Ivan Faria, Modificado em Tue, 19 Nov, 2024 às 11:59 AM por Ivan Faria

Esta documentação orienta como alterar as informações de uma autoclave no aplicativo através da API. Siga os passos abaixo para realizar as alterações de forma eficaz.


Para cadastrar uma linha de produto acesse:

 https://cristofoli.freshdesk.com/pt-PT/support/solutions/articles/153000171766-documentação-post-api-products


Passo a Passo

1. Acessar a API do APP

Inicialmente, você precisa acessar o link da API do aplicativo. Este link será o ponto de entrada para todas as requisições que você fará.

Exemplo de URL da API:

2. Autenticar-se no Endpoint /api/auth/signin

Para realizar alterações, você deve primeiro autenticar-se usando uma conta com a role ADMIN.

Requisição

  • Método: POST
  • URL: /api/auth/signin
  • Corpo da Requisição:
{  
  "username": "admin",
  "password": "senha123"
}

Resposta Esperada

  • Status: 200 OK
  • Corpo da Resposta:
  "accessToken": "seu_jwt_token", 
"tokenType": "Bearer" }

Informações Importantes:

  • accessToken: Token JWT que deve ser usado nas requisições subsequentes para autenticação.
  • tokenType: Tipo do token, geralmente Bearer.


3. Inserir o acessToken em "Authorize"
Após obter o acessToken ao logar na sua conta, você precisa inseri-lo no "Authorize" para que ganhe suas credenciais

Na parte superior da API é possível ver o botão "Authorize",você deve clicar nele e inserir o valor do campo "acessToken" 

do passo anterior


4. Obter o ID da linha de Produtos

Após autenticar-se, você precisa descobrir o id da linha de produtos (autoclave) que deseja alterar. Utilize o endpoint GET /api/products para listar todas as linhas de produto.

Requisição

  • Método: GET
  • URL: /api/products

Resposta Esperada

  • Status: 200 OK
  • Corpo da Resposta:
[  
    {        
        "id": 1,    
        "name": "Autoclave A",    
      "youtubePlaylist": "https://youtube.com/playlist?list=PLUxNmwwTJbADnuqfTW2vpGn7lToOXyjoR&si=bSNOtCYjkADz9Z5T",    
        "imgUrl": "https://cdn.dentalcremer.com.br/produtos/550/autoclave-esterilizadora-vitale-class-inox-cristofoli-dental-cremer.jpg",
        "allowClientUnlock": true,
        "prefixo": "ABC123"  
    },  
    {   
         "id": 2,   
         "name": "Autoclave B",  
         "youtubePlaylist": "https://youtube.com/playlist?list=PLUxNmwwTJbADnuqfTW2vpGn7lToOXyjoR&si=bSNOtCYjkADz9Z5T", 
        "imgUrl": "https://cdn.dentalcremer.com.br/produtos/550/autoclave-esterilizadora-vitale-class-inox-cristofoli-dental-cremer.jpg", 
        "allowClientUnlock": true,
        "prefixo": "DEF456"  
    }  
// ... outras linhas de produto ]

Passos para Obter o ID:

  1. Execute a requisição GET /api/products.
  2. Identifique a linha de produto que deseja alterar na lista retornada.
  3. Anote o id correspondente à linha de produto escolhido.


5. Alterar Informações da linha de Produtos

Com o id da linha de produtos em mãos, você pode proceder para alterar as informações desejadas usando o endpoint PUT /api/products/{id}.

Requisição

  • Método: PUT
  • URL: /api/products/{id} (Substitua {id} pelo ID da linha de produto)
  • Corpo da Requisição:
    "name": "Nova linha de produto",  
    "youtubePlaylist": "https://youtube.com/playlist?list=PLUxNmwwTJbADnuqfTW2vpGn7lToOXyjoR&si=bSNOtCYjkADz9Z5T",  
    "imgUrl": "https://cdn.dentalcremer.com.br/produtos/550/autoclave-esterilizadora-vitale-class-inox-cristofoli-dental-cremer.jpg"
    "allowClientUnlock": true,
}

Explicação dos Campos do Corpo da Requisição

  • name: Nome da linha de produto.
  • youtubePlaylist: URL da playlist que aparecerá no botão de vídeos no aplicativo. Deve ser um link válido.
  • imgUrl: URL da imagem que será exibida no aplicativo para a linha de produto.
  • allowClientUnlock: Define se o cliente pode ou não fazer o desbloqueio da autoclave.

Resposta Esperada

  • Status: 200 OK
  • Corpo da Resposta:
{  
    "id": 1,  
    "name": "Nova linha de produto",  
    "youtubePlaylist": "https://youtube.com/playlist?list=PLUxNmwwTJbADnuqfTW2vpGn7lToOXyjoR&si=bSNOtCYjkADz9Z5T",  
    "imgUrl": "https://cdn.dentalcremer.com.br/produtos/550/autoclave-esterilizadora-vitale-class-inox-cristofoli-dental-cremer.jpg",  
    "prefixo": "ABC123",
    "allowClientUnlock": true
}

Nota:

  • O campo prefixo permanece inalterado.


Conteúdo exclusivo para administradores.


Este artigo foi útil?

Isso é ótimo!

Obrigado pelo seu feedback

Lamentamos por não termos podido ajudá-lo(a)

Obrigado pelo seu feedback

Diga-nos como podemos melhorar este artigo!

Selecione pelo menos um motivo
A verificação CAPTCHA é obrigatória.

Comentário enviado

Agradecemos o seu esforço e iremos tentar corrigir o artigo