From e5bb0d57b71076b59d7828bae9b97196cd96ec23 Mon Sep 17 00:00:00 2001 From: guiafonso-ol Date: Tue, 3 Dec 2024 16:09:47 -0300 Subject: [PATCH 1/6] feat: add videoteca integration guide --- .../integrations/videoteca-player.mdx | 175 ++++++++++++++++++ .../integrations/videoteca-player.mdx | 175 ++++++++++++++++++ 2 files changed, 350 insertions(+) create mode 100644 src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx create mode 100644 src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx diff --git a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx new file mode 100644 index 0000000000..4a8814f2f7 --- /dev/null +++ b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx @@ -0,0 +1,175 @@ +--- +title: How to install the Videoteca Player integration through Azion Marketplace +description: >- + Videoteca Player provides a quick way to host your own Videofront's Videoteca player. +meta_tags: 'videoteca, video player, edge computing, integration' +namespace: docs_use_case_videoteca_player +permalink: /documentation/products/guides/videoteca-player/ +--- + +import Tabs from '~/components/tabs/Tabs' +import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx' + + + +The **Videoteca Player** integration offers a fast and efficient solution for hosting [Videofront's Videoteca](https://videofront.com.br/videoteca) player using the iframe embedding method. With this integration, you can seamlessly load videos by simply passing a query string argument, `video-id`, to specify the content to be displayed. + +--- + +## Getting the integration + +To install this integration provided by Azion's Marketplace, you have to: + + + Console + Real-Time Manager + + +1. Access [Azion Console](/en/documentation/products/guides/how-to-access-azion-console/) > **Marketplace**. +2. On the Marketplace homepage, select the integration's card. +3. Once the integration's page opens, click the **Install** button, at the bottom-right corner of the page. + +You'll see a message indicating that your integration was successfully installed. + + + +1. Access [Real-Time Manager (RTM)](https://manager.azion.com/) > **Marketplace**. +2. On the Marketplace homepage, select the integration's card. +3. Once the integration's page opens, click the **Get It Now** button, at the bottom-right corner of the page. + +You'll see a message indicating that your integration was successfully installed. + + + + +:::tip +You can search any integration by browsing through the cards, using the filters, or typing a keyword in the search bar. +::: + +--- + +## Getting the keys + +To configure this integration, you have to provide a **Videoteca** Username and API Token. To get these credentials, you must have an account at the [Videoteca site](https://videofront.com.br/videoteca). + +--- + +## Setting up the integration + +### Instantiating the edge function + +To create an instance of the integration's function: + + + Console + Real-Time Manager + + + +1. On the **Products Menu**, navigate to **Build** > **Edge Application**. +2. Select the application from the list to which you want to add the integration or [create a new edge application](/en/documentation/products/build/edge-application/first-steps/). +3. Select the **Functions Instances** tab. +4. Click the **+ Function Instance** button. +5. Give a name to your instance. +6. On the dropdown menu, select the *Videoteca Player* function. + - This action will load the **Arguments** tab, where you can add the parameters to execute your application. +7. In the **Arguments** tab, pass the three parameters: + + +```json +{ +"videoteca_user": "", // Replace with your Videoteca username +"videoteca_token": "", // Replace with your Videoteca API token +"custom_html": "" // Replace with your custom html +} +``` + +Where: + +| Variable | Required | Description | +| ---- | ----- | ----- | +| `videoteca_user` | Yes | The name of the account from where the function will retrieve the videos. | +| `videoteca_token` | Yes | The token to access the Videoteca's API. | +| `custom_html` | No | Custom HTML in the page delivered by the function. It must include the tag `` in the HTML, so the function will replace it with the actual iframe of the video. | + +:::tip +You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. +::: + +6. Click the **Save** button to save your configuration. + +Done. Now your Videoteca Player instance is saved. + + + +1. On the **Products Menu**, navigate to **BUILD** > **Edge Application**. +2. Select the application from the list to which you want to add the integration or [create a new edge application](/en/documentation/products/build/edge-application/first-steps/). +1. Select the **Functions** tab. +2. Click the **Add Function** button. +3. Give a name to your instance. +4. On the dropdown menu, select the *Videoteca Player* function. +- This action will load the function, showing a form with the function's source-code and, just above it, two tabs: **Code** and **Args**. By clicking on the **Code** tab, you'll be able to navigate through the source-code, but won't be able to change it. +5. In the **Args** tab, you'll pass the two parameters: + +```json +{ +"videoteca_user": "", // Replace with your Videoteca username +"videoteca_token": "", // Replace with your Videoteca API token +"custom_html": "" // Replace with your custom html +} +``` + +Where: + +| Variable | Required | Description | +| ---- | ----- | ----- | +| `videoteca_user` | Yes | The name of the account from where the function will retrieve the videos. | +| `videoteca_token` | Yes | The token to access the Videoteca's API. | +| `custom_html` | No | Custom HTML in the page delivered by the function. It must include the tag `` in the HTML, so the function will replace it with the actual iframe of the video. | + +:::tip +You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. +::: + +6. Click the **Save** button to save your configuration. + +Done. Now your Videoteca Player instance is saved. + + + + +### Setting up the Edge Application Rules Engine + +To finish, you have to set up the **Rules Engine** to configure the *behavior* and the *criteria* to run the function. + +Still on the **Edge Application** page: + + + Console + Real-Time Manager + + +1. Select the **Rules Engine** tab. +2. Click the **+ Rule Engine** button. +3. Give a name to the rule. +4. In **Criteria**, define the conditions for running the function. +5. Below, select a *behavior* for when the *criteria* are met. In this case, it'll be **Run Function**. + - Select the adequate function according to the name you gave it in the instantiate step. +6. Click the **Save** button. + +Done. Now the integration will run according to the criteria you set. + + + +1. Select the **Rules Engine** tab. +2. Click the **New Rule** button. +3. Give a name to the rule. +4. In **Criteria**, define the conditions for running the function. +5. Below, select a *behavior* for when the *criteria* are met. In this case, it'll be **Run Function**. + - Select the adequate function according to the name you gave it in the instantiate step. +6. Click the **Save** button. + +Done. Now the integration will run according to the criteria you set. + + + diff --git a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx new file mode 100644 index 0000000000..bf70308fc5 --- /dev/null +++ b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx @@ -0,0 +1,175 @@ +--- +title: Como instalar a integração Videoteca Player através do Azion Marketplace +description: >- + O Videoteca Player oferece uma maneira rápida de hospedar seu próprio player Videoteca do Videofront. +meta_tags: 'videoteca, video player, edge computing, integration' +namespace: docs_use_case_videoteca_player +permalink: /documentacao/produtos/guias/videoteca-player/ +--- + +import Tabs from '~/components/tabs/Tabs' +import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx' + + + +A integração **Videoteca Player** oferece uma solução rápida e eficiente para hospedar o player [Videoteca](https://videofront.com.br/videoteca) do Videofront utilizando o método de embedding iframe. Com esta integração, você pode carregar vídeos de forma contínua, simplesmente passando um argumento de tipo `query string` chamado `video-id`, para especificar o conteúdo a ser exibido. + +--- + +## Obtenha a integração + +Para instalar esta integração fornecida pelo Marketplace da Azion, você deve: + + + Console + Real-Time Manager + + +1. Acesse o [Azion Console](/pt-br/documentacao/produtos/guias/como-acessar-o-azion-console/) > **Marketplace**. +2. Na homepage do Marketplace, selecione o card da integração. +3. Quando a página da integração abrir, clique no botão **Install**, localizado no canto inferior direito. + +Aparecerá uma mensagem indicando que sua integração foi instalada com sucesso. + + + +1. Acesse o [Real-Time Manager (RTM)](https://manager.azion.com/) > **Marketplace**. +2. Na homepage do Marketplace, selecione o card da integração. +3. Quando a página da integração abrir, clique no botão **Get It Now**, localizado no canto inferior da direita. + +Aparecerá uma mensagem indicando que a integração foi instalada com sucesso. + + + + +:::tip +Você pode procurar qualquer integração navegando pelos cards, usando os filtros ou digitando uma palavra-chave na barra de busca. +::: + +--- + +## Obtenha as credenciais + +Para configurar esta integração, você deve fornecer um **Nome de Usuário** e um **Token de API** da **Videoteca**. Para obter essas credenciais, você precisa ter uma conta no [site da Videoteca](https://videofront.com.br/videoteca). + +--- + +## Configure a integração + +### Instancie a edge funciton + +Para criar uma instância da função da integração: + + + Console + Real-Time Manager + + + +1. No **Products Menu**, navegue até **Build** > **Edge Application**. +2. Selecione na lista a aplicação à qual você deseja adicionar a integração ou [crie uma nova edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/). +3. Selecione a aba **FUnction Instances**. +4. Clique no botão **+ Function Instance**. +5. Dê um nome à sua instância. +6. No menu suspenso, selecione a função *Videoteca Player*. + - Esta ação carregará a aba **Arguments**, onde você pode adicionar os parâmetros para executar sua aplicação. +7. Na aba **Arguments**, passe os três parâmetros: + + +```json +{ +"videoteca_user": "", // Substitua pelo seu nome de usuário da Videoteca +"videoteca_token": "", // Substitua pelo seu token da API da Videoteca +"custom_html": "" // Substitua pelo seu HTML personalizado +} +``` + +Onde: + +| Variável | Obrigatório | Descrição | +| ---- | ----- | ----- | +| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos. | +| `videoteca_token` | Sim | O token para acessar a API da Videoteca. | +| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo. | + +:::tip +Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. +::: + +6. Clique no botão **Save** para salvar sua configuração. + +Pronto. Agora sua instância do Videoteca Player está salva. + + + +1. No **Products Menu**, navegue até **BUILD** > **Edge Application**. +2. Selecione na lista a aplicação à qual você deseja adicionar a integração ou [crie uma nova edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/). +3. Selecione a aba **Functions**. +4. Clique no botão **Add Function**. +5. Dê um nome à sua instância. +6. No menu suspenso, selecione a função *Videoteca Player*. + - Esta ação carregará a função, mostrando um formulário com o código-fonte da função e, logo acima, duas abas: **Code** e **Args**. Ao clicar na aba **Code**, você poderá navegar pelo código-fonte, mas não poderá alterá-lo. +7. Na aba **Args**, você passará os dois parâmetros: + +```json +{ +"videoteca_user": "", // Substitua pelo seu nome de usuário da Videoteca +"videoteca_token": "", // Substitua pelo seu token da API da Videoteca +"custom_html": "" // Substitua pelo seu HTML personalizado +} +``` + +Onde: + +| Variável | Obrigatório | Descrição | +| ---- | ----- | ----- | +| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos. | +| `videoteca_token` | Sim | O token para acessar a API da Videoteca. | +| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo. | + +:::tip +Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. +::: + +6. Clique no botão **Save** para salvar sua configuração. + +Pronto. Agora sua instância do Videoteca Player está salva. + + + + +### Configure o Rules Engine + +Para finalizar, você deve configurar o **Rules Engine** para definir o *comportamento* e os *critérios* para executar a função. + +Ainda na página do **Edge Application**: + + + Console + Real-Time Manager + + +1. Selecione a aba **Rules Engine**. +2. Clique no botão **+ Rule Engine**. +3. Dê um nome à regra. +4. Em **Criteria**, defina as condições para executar a função. +5. Selecione um *behavior*(comportamento) para quando *criteria*(critérios) forem atendidos. Neste caso, escolha **Run Function**. + - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. +6. Clique no botão **Save**. + +Pronto. Agora a integração será executada de acordo com os critérios que você definiu. + + + +1. Selecione a aba **Rules Engine**. +2. Clique no botão **New Rule**. +3. Dê um nome à regra. +4. Em **Criteria**, defina as condições para executar a função. +5. Selecione um *behavior*(comportamento) para quando *criteria*(critérios) forem atendidos. Neste caso, escolha **Run Function**. + - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. +6. Clique no botão **Save**. + +Pronto. Agora a integração será executada de acordo com os critérios que você definiu. + + + From 096a9caed19eb1305c4dce5f4616a7b89ca66737 Mon Sep 17 00:00:00 2001 From: guiafonso-ol Date: Tue, 3 Dec 2024 16:56:04 -0300 Subject: [PATCH 2/6] fix: add suggested changes --- .../integrations/videoteca-player.mdx | 24 +++++++++---------- .../integrations/videoteca-player.mdx | 14 +++++------ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx index 4a8814f2f7..b2ea2ff212 100644 --- a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx @@ -12,7 +12,13 @@ import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx' -The **Videoteca Player** integration offers a fast and efficient solution for hosting [Videofront's Videoteca](https://videofront.com.br/videoteca) player using the iframe embedding method. With this integration, you can seamlessly load videos by simply passing a query string argument, `video-id`, to specify the content to be displayed. +The **Videoteca Player** integration offers a fast and efficient solution for hosting [Videofront's Videoteca](https://videofront.com.br/videoteca) player using the iframe embedding method. With this integration, you can load videos by simply passing the `video-id` query string argument to specify the content to be displayed. + +--- + +## Requirements + +To set up this integration, you need to provide a **Username** and an **API Token** from **Videoteca**. To obtain these credentials, you need to have an account on the [Videoteca website](https://videofront.com.br/videoteca). --- @@ -48,12 +54,6 @@ You can search any integration by browsing through the cards, using the filters, --- -## Getting the keys - -To configure this integration, you have to provide a **Videoteca** Username and API Token. To get these credentials, you must have an account at the [Videoteca site](https://videofront.com.br/videoteca). - ---- - ## Setting up the integration ### Instantiating the edge function @@ -66,7 +66,7 @@ To create an instance of the integration's function: -1. On the **Products Menu**, navigate to **Build** > **Edge Application**. +1. On the **Products menu**, navigate to **Build** > **Edge Application**. 2. Select the application from the list to which you want to add the integration or [create a new edge application](/en/documentation/products/build/edge-application/first-steps/). 3. Select the **Functions Instances** tab. 4. Click the **+ Function Instance** button. @@ -88,21 +88,21 @@ Where: | Variable | Required | Description | | ---- | ----- | ----- | -| `videoteca_user` | Yes | The name of the account from where the function will retrieve the videos. | +| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos. | | `videoteca_token` | Yes | The token to access the Videoteca's API. | -| `custom_html` | No | Custom HTML in the page delivered by the function. It must include the tag `` in the HTML, so the function will replace it with the actual iframe of the video. | +| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video. | :::tip You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. ::: -6. Click the **Save** button to save your configuration. +8. Click the **Save** button to save your configuration. Done. Now your Videoteca Player instance is saved. -1. On the **Products Menu**, navigate to **BUILD** > **Edge Application**. +1. On the **Products menu**, navigate to **BUILD** > **Edge Application**. 2. Select the application from the list to which you want to add the integration or [create a new edge application](/en/documentation/products/build/edge-application/first-steps/). 1. Select the **Functions** tab. 2. Click the **Add Function** button. diff --git a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx index bf70308fc5..b26a0bc1c8 100644 --- a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx @@ -12,7 +12,13 @@ import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx' -A integração **Videoteca Player** oferece uma solução rápida e eficiente para hospedar o player [Videoteca](https://videofront.com.br/videoteca) do Videofront utilizando o método de embedding iframe. Com esta integração, você pode carregar vídeos de forma contínua, simplesmente passando um argumento de tipo `query string` chamado `video-id`, para especificar o conteúdo a ser exibido. +A integração **Videoteca Player** oferece uma solução rápida e eficiente para hospedar o player [Videoteca](https://videofront.com.br/videoteca) do Videofront utilizando o método de embedding iframe. Com esta integração, você pode carregar vídeos simplesmente passando o argumento `video-id` como uma `query string` para especificar o conteúdo a ser exibido. + +--- + +## Requisitos + +Para configurar esta integração, você deve fornecer um **Nome de Usuário** e um **Token de API** da **Videoteca**. Para obter essas credenciais, você precisa ter uma conta no [site da Videoteca](https://videofront.com.br/videoteca). --- @@ -48,12 +54,6 @@ Você pode procurar qualquer integração navegando pelos cards, usando os filtr --- -## Obtenha as credenciais - -Para configurar esta integração, você deve fornecer um **Nome de Usuário** e um **Token de API** da **Videoteca**. Para obter essas credenciais, você precisa ter uma conta no [site da Videoteca](https://videofront.com.br/videoteca). - ---- - ## Configure a integração ### Instancie a edge funciton From 0f4e21fc971bd11af13675236d960a7ecd287552 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Oliveira Date: Wed, 4 Dec 2024 09:13:22 -0300 Subject: [PATCH 3/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --- .../integrations/videoteca-player.mdx | 18 +++++------ .../integrations/videoteca-player.mdx | 32 +++++++++---------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx index b2ea2ff212..9043f04b97 100644 --- a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx @@ -73,7 +73,7 @@ To create an instance of the integration's function: 5. Give a name to your instance. 6. On the dropdown menu, select the *Videoteca Player* function. - This action will load the **Arguments** tab, where you can add the parameters to execute your application. -7. In the **Arguments** tab, pass the three parameters: +7. In the **Arguments** tab, pass these parameters: ```json @@ -104,12 +104,12 @@ Done. Now your Videoteca Player instance is saved. 1. On the **Products menu**, navigate to **BUILD** > **Edge Application**. 2. Select the application from the list to which you want to add the integration or [create a new edge application](/en/documentation/products/build/edge-application/first-steps/). -1. Select the **Functions** tab. -2. Click the **Add Function** button. -3. Give a name to your instance. -4. On the dropdown menu, select the *Videoteca Player* function. +3. Select the **Functions** tab. +4. Click the **Add Function** button. +5. Give a name to your instance. +6. On the dropdown menu, select the *Videoteca Player* function. - This action will load the function, showing a form with the function's source-code and, just above it, two tabs: **Code** and **Args**. By clicking on the **Code** tab, you'll be able to navigate through the source-code, but won't be able to change it. -5. In the **Args** tab, you'll pass the two parameters: +7. In the **Args** tab, you'll pass these parameters: ```json { @@ -131,7 +131,7 @@ Where: You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. ::: -6. Click the **Save** button to save your configuration. +8. Click the **Save** button to save your configuration. Done. Now your Videoteca Player instance is saved. @@ -153,7 +153,7 @@ Still on the **Edge Application** page: 2. Click the **+ Rule Engine** button. 3. Give a name to the rule. 4. In **Criteria**, define the conditions for running the function. -5. Below, select a *behavior* for when the *criteria* are met. In this case, it'll be **Run Function**. +5. Below, select the **Run Function** behavior. - Select the adequate function according to the name you gave it in the instantiate step. 6. Click the **Save** button. @@ -165,7 +165,7 @@ Done. Now the integration will run according to the criteria you set. 2. Click the **New Rule** button. 3. Give a name to the rule. 4. In **Criteria**, define the conditions for running the function. -5. Below, select a *behavior* for when the *criteria* are met. In this case, it'll be **Run Function**. +5. Below, select the **Run Function** behavior. . - Select the adequate function according to the name you gave it in the instantiate step. 6. Click the **Save** button. diff --git a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx index b26a0bc1c8..cf8f597fb5 100644 --- a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx @@ -1,5 +1,5 @@ --- -title: Como instalar a integração Videoteca Player através do Azion Marketplace +title: Como instalar a integração Videoteca Player através do Marketplace da Azion description: >- O Videoteca Player oferece uma maneira rápida de hospedar seu próprio player Videoteca do Videofront. meta_tags: 'videoteca, video player, edge computing, integration' @@ -66,14 +66,14 @@ Para criar uma instância da função da integração: -1. No **Products Menu**, navegue até **Build** > **Edge Application**. +1. No **Products menu**, navegue até **Build** > **Edge Application**. 2. Selecione na lista a aplicação à qual você deseja adicionar a integração ou [crie uma nova edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/). -3. Selecione a aba **FUnction Instances**. +3. Selecione a aba **Function Instances**. 4. Clique no botão **+ Function Instance**. 5. Dê um nome à sua instância. 6. No menu suspenso, selecione a função *Videoteca Player*. - Esta ação carregará a aba **Arguments**, onde você pode adicionar os parâmetros para executar sua aplicação. -7. Na aba **Arguments**, passe os três parâmetros: +7. Na aba **Arguments**, passe esses parâmetros: ```json @@ -88,28 +88,28 @@ Onde: | Variável | Obrigatório | Descrição | | ---- | ----- | ----- | -| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos. | -| `videoteca_token` | Sim | O token para acessar a API da Videoteca. | -| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo. | +| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos | +| `videoteca_token` | Sim | O token para acessar a API da Videoteca | +| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo | :::tip Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. ::: -6. Clique no botão **Save** para salvar sua configuração. +8. Clique no botão **Save** para salvar sua configuração. Pronto. Agora sua instância do Videoteca Player está salva. -1. No **Products Menu**, navegue até **BUILD** > **Edge Application**. +1. No **Products menu**, navegue até **BUILD** > **Edge Application**. 2. Selecione na lista a aplicação à qual você deseja adicionar a integração ou [crie uma nova edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/). 3. Selecione a aba **Functions**. 4. Clique no botão **Add Function**. 5. Dê um nome à sua instância. 6. No menu suspenso, selecione a função *Videoteca Player*. - Esta ação carregará a função, mostrando um formulário com o código-fonte da função e, logo acima, duas abas: **Code** e **Args**. Ao clicar na aba **Code**, você poderá navegar pelo código-fonte, mas não poderá alterá-lo. -7. Na aba **Args**, você passará os dois parâmetros: +7. Na aba **Args**, você passará esses parâmetros: ```json { @@ -123,15 +123,15 @@ Onde: | Variável | Obrigatório | Descrição | | ---- | ----- | ----- | -| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos. | -| `videoteca_token` | Sim | O token para acessar a API da Videoteca. | -| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo. | +| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos | +| `videoteca_token` | Sim | O token para acessar a API da Videoteca | +| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo | :::tip Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. ::: -6. Clique no botão **Save** para salvar sua configuração. +8. Clique no botão **Save** para salvar sua configuração. Pronto. Agora sua instância do Videoteca Player está salva. @@ -153,7 +153,7 @@ Ainda na página do **Edge Application**: 2. Clique no botão **+ Rule Engine**. 3. Dê um nome à regra. 4. Em **Criteria**, defina as condições para executar a função. -5. Selecione um *behavior*(comportamento) para quando *criteria*(critérios) forem atendidos. Neste caso, escolha **Run Function**. +5. Selecione o *behavior*(comportamento) **Run Function**. - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. 6. Clique no botão **Save**. @@ -165,7 +165,7 @@ Pronto. Agora a integração será executada de acordo com os critérios que voc 2. Clique no botão **New Rule**. 3. Dê um nome à regra. 4. Em **Criteria**, defina as condições para executar a função. -5. Selecione um *behavior*(comportamento) para quando *criteria*(critérios) forem atendidos. Neste caso, escolha **Run Function**. +5. Selecione o *behavior*(comportamento) **Run Function**. - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. 6. Clique no botão **Save**. From 7012ee52d15e1174a20b413fb4923b3c9a602fd6 Mon Sep 17 00:00:00 2001 From: guiafonso-ol Date: Wed, 4 Dec 2024 09:24:56 -0300 Subject: [PATCH 4/6] fix: apply suggestions from review --- .../marketplace/integrations/videoteca-player.mdx | 4 ++-- .../marketplace/integrations/videoteca-player.mdx | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx index 9043f04b97..6d5a89811e 100644 --- a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx @@ -123,9 +123,9 @@ Where: | Variable | Required | Description | | ---- | ----- | ----- | -| `videoteca_user` | Yes | The name of the account from where the function will retrieve the videos. | +| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos. | | `videoteca_token` | Yes | The token to access the Videoteca's API. | -| `custom_html` | No | Custom HTML in the page delivered by the function. It must include the tag `` in the HTML, so the function will replace it with the actual iframe of the video. | +| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video. | :::tip You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. diff --git a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx index cf8f597fb5..b5541d326f 100644 --- a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx @@ -18,7 +18,7 @@ A integração **Videoteca Player** oferece uma solução rápida e eficiente pa ## Requisitos -Para configurar esta integração, você deve fornecer um **Nome de Usuário** e um **Token de API** da **Videoteca**. Para obter essas credenciais, você precisa ter uma conta no [site da Videoteca](https://videofront.com.br/videoteca). +Para configurar esta integração, você deve fornecer um **Username** e um **API Token** da **Videoteca**. Para obter essas credenciais, você precisa ter uma conta no [site da Videoteca](https://videofront.com.br/videoteca). --- @@ -88,9 +88,9 @@ Onde: | Variável | Obrigatório | Descrição | | ---- | ----- | ----- | -| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos | +| `videoteca_user` | Sim | O nome da conta da qual a função irá recuperar os vídeos | | `videoteca_token` | Sim | O token para acessar a API da Videoteca | -| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo | +| `custom_html` | Não | HTML personalizado para a página entregue pela função. Deve incluir a tag `` no HTML para que a função a substitua pelo iframe real do vídeo | :::tip Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. @@ -123,9 +123,9 @@ Onde: | Variável | Obrigatório | Descrição | | ---- | ----- | ----- | -| `videoteca_user` | Sim | O nome da conta de onde a função irá recuperar os vídeos | +| `videoteca_user` | Sim | O nome da conta da qual a função irá recuperar os vídeos | | `videoteca_token` | Sim | O token para acessar a API da Videoteca | -| `custom_html` | Não | HTML personalizado na página entregue pela função. Deve incluir a tag `` no HTML, para que a função a substitua pelo iframe real do vídeo | +| `custom_html` | Não | HTML personalizado para a página entregue pela função. Deve incluir a tag `` no HTML para que a função a substitua pelo iframe real do vídeo | :::tip Você pode obter seu token em: `https://.videotecaead.com.br/Apidoc`, substituindo `` pelo seu nome de usuário da Videoteca. From 5767d53e46c2d0935dd31a8b7e11776fc5e77049 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Oliveira Date: Wed, 4 Dec 2024 09:45:17 -0300 Subject: [PATCH 5/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --- .../marketplace/integrations/videoteca-player.mdx | 14 +++++++------- .../marketplace/integrations/videoteca-player.mdx | 8 ++++---- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx index 6d5a89811e..ddbd1959d4 100644 --- a/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/en/pages/guides/marketplace/integrations/videoteca-player.mdx @@ -24,7 +24,7 @@ To set up this integration, you need to provide a **Username** and an **API Toke ## Getting the integration -To install this integration provided by Azion's Marketplace, you have to: +To install this integration provided by Azion Marketplace, you have to: Console @@ -88,9 +88,9 @@ Where: | Variable | Required | Description | | ---- | ----- | ----- | -| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos. | -| `videoteca_token` | Yes | The token to access the Videoteca's API. | -| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video. | +| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos | +| `videoteca_token` | Yes | The token to access the Videoteca's API | +| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video | :::tip You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. @@ -123,9 +123,9 @@ Where: | Variable | Required | Description | | ---- | ----- | ----- | -| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos. | -| `videoteca_token` | Yes | The token to access the Videoteca's API. | -| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video. | +| `videoteca_user` | Yes | The name of the account from which the function will retrieve the videos | +| `videoteca_token` | Yes | The token to access the Videoteca's API | +| `custom_html` | No | Custom HTML for the page delivered by the function. It must include the tag `` in the HTML, as the function will replace it with the actual iframe of the video | :::tip You can get your token at: `https://.videotecaead.com.br/Apidoc` replacing `` with your actual Videoteca username. diff --git a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx index b5541d326f..edcd06340e 100644 --- a/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx +++ b/src/content/docs/pt-br/pages/guias/marketplace/integrations/videoteca-player.mdx @@ -24,7 +24,7 @@ Para configurar esta integração, você deve fornecer um **Username** e um **AP ## Obtenha a integração -Para instalar esta integração fornecida pelo Marketplace da Azion, você deve: +Para instalar esta integração fornecida pelo Marketplace da Azion: Console @@ -56,7 +56,7 @@ Você pode procurar qualquer integração navegando pelos cards, usando os filtr ## Configure a integração -### Instancie a edge funciton +### Instancie a edge function Para criar uma instância da função da integração: @@ -153,7 +153,7 @@ Ainda na página do **Edge Application**: 2. Clique no botão **+ Rule Engine**. 3. Dê um nome à regra. 4. Em **Criteria**, defina as condições para executar a função. -5. Selecione o *behavior*(comportamento) **Run Function**. +5. Selecione o *behavior* (comportamento) **Run Function**. - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. 6. Clique no botão **Save**. @@ -165,7 +165,7 @@ Pronto. Agora a integração será executada de acordo com os critérios que voc 2. Clique no botão **New Rule**. 3. Dê um nome à regra. 4. Em **Criteria**, defina as condições para executar a função. -5. Selecione o *behavior*(comportamento) **Run Function**. +5. Selecione o *behavior* (comportamento) **Run Function**. - Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação. 6. Clique no botão **Save**. From 19df4fb1ad5fbd0d7dd95d5e7569d54723af9170 Mon Sep 17 00:00:00 2001 From: guiafonso-ol Date: Wed, 4 Dec 2024 11:21:16 -0300 Subject: [PATCH 6/6] feat: add entry to guides home --- src/content/docs/en/pages/guides/index.mdx | 4 +--- src/content/docs/pt-br/pages/guias/guides.mdx | 1 + 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/content/docs/en/pages/guides/index.mdx b/src/content/docs/en/pages/guides/index.mdx index d56dde4140..5a79747068 100644 --- a/src/content/docs/en/pages/guides/index.mdx +++ b/src/content/docs/en/pages/guides/index.mdx @@ -217,6 +217,4 @@ permalink: /documentation/products/guides/ - [How to install the Signed Cookies integration through Azion Marketplace](/en/documentation/products/guides/signed-cookies/) - [How to install the Upstash Rate Limiting integration through Azion Marketplace](/en/documentation/products/guides/upstash-rate-limiting-integration/) - [How to install the Upstash Waiting Room integration through Azion Marketplace](/en/documentation/products/guides/waiting-room/) - - - +- [How to install the Videoteca Player integration through Azion Marketplace](/en/documentation/products/guides/videoteca-player/) diff --git a/src/content/docs/pt-br/pages/guias/guides.mdx b/src/content/docs/pt-br/pages/guias/guides.mdx index af7eb36f34..e528be2972 100644 --- a/src/content/docs/pt-br/pages/guias/guides.mdx +++ b/src/content/docs/pt-br/pages/guias/guides.mdx @@ -217,3 +217,4 @@ permalink: /documentacao/produtos/guias/ - [Como utilizar a integração Signed Cookies do Marketplace da Azion](/pt-br/documentacao/produtos/guias/signed-cookies/) - [Como utilizar a integração Upstash Rate Limiting através do Marketplace da Azion](/pt-br/documentacao/produtos/guias/upstash-rate-limiting-integration/) - [Como utilizar a integração Upstash Waiting Room através do Marketplace](/pt-br/documentacao/produtos/guias/waiting-room/) +- [Como utilizar a integração Videoteca Player através do Marketplace da Azion](/pt-br/documentacao/produtos/guias/videoteca-player/)