# Criando novas aplicações de Usuário

Ao configurar um novo **Aplicativo do usuário**, você trabalhará com várias configurações principais que determinam como seu aplicativo externo se integra à plataforma. Vamos explorar cada componente essencial.

Comece clicando em <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-b205ed1cd11ae77328c30a95f8af7d8d5be21be8%2Fchrome_py0qhiu5p8.webp?alt=media" alt="chrome_py0qhiu5p8.webp" data-size="line"> botão na **Aplicações de usuário** lista. No formulário de configuração que apareceu, prossiga com as seguintes etapas:

{% stepper %}
{% step %}
**Defina a URL**

Especifique a URL do seu aplicativo — o endereço onde seu aplicativo é hospedado; ela serve como base para a integração.

{% hint style="danger" %}

* Garanta que a URL seja válida, utilize conexão HTTPS, aponte para um recurso confiável e não contenha mais de 1000 caracteres.
* Verifique se o aplicativo possui a configuração de iFrame habilitada no seu lado; caso contrário, você não conseguirá abri‑lo na interface da plataforma.
  {% endhint %}
  {% endstep %}

{% step %}
**Configure os parâmetros básicos**

Para personalizar seu aplicativo, você pode incluir vários parâmetros na URL. Você pode adicionar parâmetros manualmente no campo de URL ou usar uma de nossas sugestões: idioma, ID do usuário ou fuso horário. Clique em uma sugestão de parâmetro para adicioná‑la ao final da URL. Expanda a descrição abaixo para saber mais sobre os parâmetros sugeridos e exemplos.

<details>

<summary>Compreendendo os parâmetros de URL sugeridos</summary>

Sugerimos alguns parâmetros básicos para personalização

1. `?locale={locale_code}`\
   Parâmetro de idioma que corresponde automaticamente ao idioma da plataforma do usuário.

* Exemplo: `https://your-app.com/dashboard?locale=en`

2. `?user_id={user_identifier}`\
   Parâmetro de contexto do usuário que transmite a identidade do usuário para filtrar informações personalizadas.

* Exemplo: `https://your-app.com/dashboard?user_id=12345`

3. `?timezone={timezone}`\
   Parâmetro de horário que corresponde automaticamente ao fuso horário da plataforma do usuário.

* Exemplo: `https://your-app.com/dashboard?timezone=UTC+1`

Você pode editar o nome do parâmetro sugerido ou especificar um valor determinado para ele.

</details>

![Exemplo de URL do aplicativo com parâmetros](https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-5ef1c1516fcc65f19333029d0918f4a42d1a5605%2FURL_with_Params.png?alt=media)

{% hint style="info" %}
Teste sua configuração para garantir que o aplicativo carregue corretamente. Clique <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-78171811e50248dd9b883328ca7b69ec6cf767bf%2Fimage-20241217-083119.png?alt=media" alt="image-20241217-083119.png" data-size="line"> para exibir uma pré‑visualização.
{% endhint %}
{% endstep %}

{% step %}
**Ajuste a aparência**

Crie uma identidade reconhecível para seu aplicativo para torná‑lo fácil de acessar. As seguintes configurações ajudarão você a fazer isso:

* **Rótulo** – Adicione um nome único e descritivo para seu app (até 24 caracteres). Ele será exibido na barra lateral da plataforma.
* **Descrição** – Adicione uma breve explicação com detalhes sobre a funcionalidade do app ou destaque informações importantes (até 50 caracteres). Uma descrição informativa ajudará seus usuários a entender melhor a finalidade do app.
* **Ícone** – Selecione um ícone que represente a função do seu aplicativo para uma navegação ainda mais nativa.
  {% endstep %}

{% step %}
**Selecione o método de exibição**

Decida como seu aplicativo será aberto escolhendo uma das duas opções no **Abrir em** menu suspenso:

* **Incorporado** – O app aparece dentro da interface da plataforma
* **Nova aba** – O app abre em uma aba separada do navegador

{% hint style="info" %}
Nossa plataforma utiliza iFrame para incorporação. Como nem todas as URLs podem ser processadas com sucesso por essa tecnologia, certifique‑se de pré‑visualizar o resultado da incorporação. Se você encontrar qualquer problema com esse método de exibição, considere usar **Nova aba**.
{% endhint %}
{% endstep %}

{% step %}
**Configurar autenticação (opcional)**

Configure a autenticação se seu aplicativo depender da API da plataforma. Nesse caso, a plataforma fornecerá os dados de autenticação diretamente ao aplicativo quando ele for aberto, eliminando a necessidade de implementar funcionalidade de login adicional no lado do seu aplicativo.\
Você pode escolher um dos dois métodos de autenticação:

* **Chave de API**
  * Esse método é para aplicativos onde o gerenciamento de funções ou permissões de usuário não é necessário.
  * A chave da API corresponde ao nível de acesso do proprietário da conta. Isso significa que fornecer a um usuário comum uma chave da API pode conceder a ele acesso a **todos os dados** disponíveis para o usuário principal.\
    Por exemplo, se seu aplicativo trabalha com rastreadores aos quais um usuário tem direitos limitados ou nenhum acesso, o uso da chave da API ainda exporá todos os rastreadores da conta principal.
* **Chave de sessão**
  * Esse método é recomendado quando há gerenciamento de funções envolvido.
  * Transmite a chave de sessão do usuário atual para o aplicativo.

{% hint style="info" %}
Selecionar o **Chave de API** método desabilitará automaticamente o **Chave de sessão** método, e vice‑versa. Apenas um método pode ser usado por vez.
{% endhint %}

Quando a autenticação está habilitada, a plataforma acrescenta o `?session_key=` parâmetro à URL do seu aplicativo.

* Se você selecionou um **Chave de API**, o valor do parâmetro conterá essa chave.
* Se você optou por um **Chave de sessão**, o valor do parâmetro incluirá a chave da sessão do usuário atual a partir da qual o aplicativo está sendo acessado.

Certifique‑se de que o aplicativo seja capaz de ler e usar esse parâmetro.
{% endstep %}

{% step %}
**Salve o novo aplicativo**

Clique no **Salvar** botão. Seu aplicativo aparecerá na **Aplicações de usuário** lista e na barra lateral da plataforma. Aplicativos habilitados tornam‑se automaticamente disponíveis para os usuários da conta.
{% endstep %}
{% endstepper %}

<figure><img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-f3208949947b9860b2bd4665a35ccfa6708d32bb%2Fimage.png?alt=media" alt=""><figcaption><p>Exemplo de visualização do Aplicativo do usuário incorporado</p></figcaption></figure>

<details>

<summary>Dicas rápidas de solução de problemas</summary>

Se seu aplicativo não for exibido corretamente quando incorporado, tente:

* Abrir em uma nova aba em vez disso
* Verificar se sua URL está correta e acessível
* Checar se todos os parâmetros estão formatados corretamente

</details>

Os aplicativos criados permanecem totalmente configuráveis após serem salvos. Você pode ajustar seus parâmetros e aparência a qualquer momento. Para saber mais sobre gerenciamento de aplicativos, consulte [Gerenciando Aplicativos do Usuário existentes](https://www.navixy.com/docs/user/pt-br/guide/account/user-applications/managing-existing-user-applications).
