Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Parâmetros Configuráveis

Além dos métodos obrigatórios e opcionais fornecidos diretamente na chamada da API, o sistema também oferece a possibilidade de configuração de parâmetros adicionais através do painel público. Esses parâmetros permitem personalizar o comportamento e as funcionalidades da API de acordo com as necessidades específicas do usuário.

Parâmetros da funcionalidade

  1. [Nome do Parâmetro 1]: Descrição breve do parâmetro e sua finalidadeTempo Tolerância Confirmar Presença Minutos]: Define o tempo de exibição dos botões de confirmar presença e cancelar consulta após o horário marcado da consulta.

    Exemplo:

    • Tempo Tolerância : exemplo_parametro_1

      Descrição: Este parâmetro controla a frequência de atualização dos dados

      Confirmar Presença Minutos: tempoToleranciaConfirmarPresencaMinutos

      • Descrição: O tempo deve ser em minutos.

      • Tipo: StringNumber

      • Valores Possíveis: "diário", "semanal", "mensal"

  2. [Nome do Parâmetro 2]: Descrição breve do parâmetro e sua finalidade.

    Exemplo:

    • Nome do Parâmetro 2: exemplo_parametro_2

      • Descrição: Este parâmetro determina o formato de retorno dos resultados.

      • Tipo: String

      • Valores Possíveis: "json", "xml"

  3. [Nome do Parâmetro 3]: Descrição breve do parâmetro e sua finalidade.

    Exemplo:

    • Nome do Parâmetro 3: exemplo_parametro_3

      • Descrição: Este parâmetro ativa ou desativa uma funcionalidade específica.

      • Tipo: Boolean

      • Valores Possíveis: true, false10, 20, 30

Image AddedImage Added
  1. [Tempo Permitir Confirmar Presença Minutos]: Define em quanto tempo antes da consulta o botão de confirmar deve ser exibido para o beneficiário.

    Exemplo:

    • Tempo Permitir Confirmar Presença Minutos: tempoPermitirConfirmarPresencaMinutos

      • Descrição: Tempo em minutos, default: 1440 (24h).

      • Tipo: Number

      • Valores Possíveis: 120 240

Image AddedImage Added
  1. [Tempo Exibição Entrar Tele Consulta]: Define o tempo de exibição do botão de entrar na tele consulta após o inicio do atendimento.

    Exemplo:

    • Tempo Exibição Entrar Tele Consulta: tempoExibicaoEntrarTeleconsulta

      • Descrição: O tempo deve ser em minutos.

      • Tipo: Number

      • Valores Possíveis: 10, 15, 20

  2. [Tempo Permitir Exibição Botão Tele Consulta]: Define o tempo de exibição do botão de entra na sala de espera ANTES da data agendada.

    Exemplo:

    • Tempo Permitir Exibição Botão Tele Consulta: tempoPermitirExibicaoBotaoTeleconsulta

      • Descrição: O tempo deve ser em minutos, default: 1440 (24h).

      • Tipo: Number

      • Valores Possíveis: 120 240

Image AddedImage Added

Como Configurar os Parâmetros

Para configurar os parâmetros acima mencionados e outros disponíveis, siga as instruções abaixo:

  1. Acesse o Painel Público e faça login com suas credenciais.

  2. Navegue até a seção de Configurações ou Personalizações da APIFuncionalidades > Sandbox.

  3. Localize a seção de Parâmetros Configuráveis.Insira no menu “Serviços” a funcionalidade desejada, aba “Parâmetros” .

  4. Localize e insira os valores desejados para os parâmetros disponíveisdesejados.

  5. Salve as alterações.

...