> For the complete documentation index, see [llms.txt](https://docs.yoplanning.support/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yoplanning.support/pt/academia-yoplanning/yoplanning-parametrage/module-de-reservation/integration-du-module-de-reservation/doc-technique-agence-web/introduction-doc-technique.md).

# Introdução: Documento Técnico

### Introdução

Esta documentação destina-se a desenvolvedores e webmasters que desejam integrar o módulo de reservas Yoplanning.pro em seus sites. O objetivo é melhorar a experiência do usuário, oferecendo uma interface de reservas acessível e responsiva, além de permitir a personalização do módulo.

### Princípio de funcionamento

O módulo de reservas do Yoplanning.pro foi projetado para se integrar perfeitamente ao seu site, oferecendo uma experiência de usuário fluida e sem a necessidade de redirecionamentos. O módulo aparece como uma janela pop-up ativada por um botão ou link, permitindo que os usuários façam reservas diretamente no seu site.

#### Benefícios

* **Exibição ideal**: Adapta-se a todos os tipos de telas, incluindo as de dispositivos móveis.
* **Integração fácil**: Pode ser adicionado ao seu site com um simples código JavaScript.
* **Personalização**: Geração de links específicos para diferentes ações ou categorias.

#### Integração via iFrame

Embora possível, a integração via iframe não é recomendada devido a problemas de compatibilidade com dispositivos móveis. Se necessário, o módulo pode ser aberto em uma nova aba para uma experiência em tela cheia.

#### Integração via iframe: comportamento de rolagem

No modo iframe, por padrão, o módulo de reservas ocupa toda a altura da página e a rolagem é exibida no seu site, conforme mostrado na captura de tela abaixo:

<figure><img src="/files/K3kQaCW1XFSAVs5yYVmg" alt="" width="563"><figcaption><p>Comportement par défaut</p></figcaption></figure>

Esse comportamento pode ser alterado adicionando o parâmetro `bescroll=inside` à URL de integração do módulo de reservas. O módulo então ocupará a altura da tela e a rolagem ocorrerá dentro do módulo, em vez de no seu site, como mostrado na captura de tela abaixo:

<figure><img src="/files/wnVyJC6SJkjdEvULQYGD" alt="" width="563"><figcaption><p>Avec le paramètre "bescroll=inside"</p></figcaption></figure>

### Código de integração

Para integrar o módulo, insira o seguinte código JavaScript na seção `<header>` do seu site. Isso permitirá que o módulo fique acessível em todas as páginas sem a necessidade de múltiplas inserções.

```html
<script type="text/javascript" src="https://booking.yoplanning.pro/integration/script.js" async></script>
```

### Gerando os links do módulo de reservas

É possível gerar links específicos para o módulo de reservas através do painel administrativo do Yoplanning:

1. Acesse **Configurações > Módulo de Reservas > Menu de Integração**.
2. Utilize o modo URL para criar um URL personalizado de acordo com suas necessidades.

#### Exemplos de links gerados

* **Link geral**: `https://booking.yoplanning.pro/<UNIQUE_ID>/`
* **Categoria específica**: `https://booking.yoplanning.pro/<UNIQUE_ID>/?tag=<CATEGORY_ID>`
* **Página do produto**: `https://booking.yoplanning.pro/<UNIQUE_ID>/product/<PRODUCT_ID>`
* **Acesso direto ao carrinho de compras**: `https://booking.yoplanning.pro/<UNIQUE_ID>/cart/`
* **Compre diretamente**: `https://booking.yoplanning.pro/<UNIQUE_ID>/shop/`

#### Opções de integração

O Yoplanning oferece vários métodos de integração:

* **Botão**: Para acesso direto através de um botão clicável.
* **Ícone flutuante**: Um ícone acessível a qualquer momento na página.
* **Hiperlink**: Para incorporar em texto ou imagens.
* **Iframe**: Usado como último recurso, caso o JavaScript esteja restrito.
* **URL simples**: Para integração direta como um link.

### Gestão Multilíngue

O módulo detecta automaticamente o idioma do navegador do usuário usando o serviço externo <https://gtranslate.io/detect-browser-language>, proporcionando uma experiência localizada e intuitiva. *(Método recomendado na maioria dos casos.)*

#### Idioma definido por padrão.

Se você possui um site multilíngue, está enfrentando problemas de detecção de idioma ou deseja forçar a exibição do módulo em um idioma específico, você pode criar um módulo de reservas específico, definindo o idioma em sua configuração.

### Conclusão

A integração do módulo de reservas Yoplanning.pro melhora significativamente a experiência de reserva no seu site, graças à sua interface de usuário otimizada, opções avançadas de personalização e suporte multilíngue. Siga as instruções fornecidas para uma integração bem-sucedida e para oferecer aos seus usuários uma experiência de reserva perfeita.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.yoplanning.support/pt/academia-yoplanning/yoplanning-parametrage/module-de-reservation/integration-du-module-de-reservation/doc-technique-agence-web/introduction-doc-technique.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
