Pular para o conteúdo principal
Programa de Acesso Antecipado

Os Apps Lua da Turn.io estão atualmente em um programa de acesso antecipado e ainda não estão disponíveis ao público geral. Se você tem interesse em construir aplicativos personalizados e gostaria de participar, entre em contato com nossa equipe de suporte para discutir seu caso de uso.

Construindo Apps Lua na Turn.io

Bem-vindo ao guia do desenvolvedor para construir Apps Lua na plataforma Turn.io! Este guia irá orientá-lo em tudo que você precisa saber para criar, testar e implantar aplicativos poderosos que estendem as capacidades da Turn.io.

O que são os Apps Lua da Turn.io?​

Os Apps Lua da Turn são pacotes autocontidos de código Lua que executam de forma segura dentro da plataforma Turn.io. Eles permitem que você implemente lógica de negócio personalizada que pode ser ativada por eventos da plataforma, requisições HTTP, ou diretamente de uma Jornada.

Com os Apps Lua, você pode:

  • Integrar com APIs externas e sistemas de terceiros.
  • Criar fluxos de trabalho complexos e com estado que vão além das capacidades padrão de Jornada.
  • Construir lógica de backend personalizada para seus serviços de mensagens.
  • Lidar com eventos assíncronos, como aguardar um webhook de confirmação de pagamento.

Começando: Seu Primeiro App​

A maneira mais rápida de começar é usando nossa imagem Docker Turn Lua SDK, que fornece um ambiente de desenvolvimento completo com ferramentas de scaffolding, testes e empacotamento.

Início Rápido com Docker SDK​

  1. Configure o alias Docker (configuração única):

    # Adicione isso ao seu ~/.bashrc ou ~/.zshrc
    alias turn-app='docker run --rm -v $(pwd):/workspace ghcr.io/turnhub/turn-lua-sdk:latest turn-app'

  2. Crie um novo app:

    turn-app new my_app
    cd my_app

  3. Sua estrutura de projeto ficará assim:

    my_app/
    ├── my_app.lua                  # Seu arquivo principal da aplicação
    ├── spec/
    │   └── my_app_spec.lua         # Arquivo de teste usando framework lester
    ├── assets/
    │   ├── manifest.json           # Metadados do app (obrigatório)
    │   ├── README.md               # Documentação exibida na UI da Turn.io
    │   ├── journeys/               # Arquivos markdown de jornadas
    │   ├── templates/              # Arquivos JSON de templates de mensagem
    │   ├── flows/                  # Arquivos JSON de WhatsApp Flows
    │   └── liquid/                 # Templates Liquid
    ├── lib/                        # Módulos Lua adicionais
    ├── Makefile                    # Comandos de build convenientes
    ├── README.md                   # Documentação do projeto
    └── .gitignore

  4. Execute seus testes:

    make test          # Executar testes uma vez
    make watch         # Modo watch - executa testes automaticamente ao alterar arquivos

  5. Empacote para implantação:

    make build         # Cria my_app-0.0.1.zip

Alternativa: Usando o Diretório de Template​

Se você preferir não usar Docker, ainda pode usar nosso template tradicional:

  1. Baixe o Template: Obtenha uma cópia do diretório lua_app_template do repositório.

  2. Execute os Testes:

    # Da raiz do projeto - constrói a imagem Luerl e executa os testes
    make test-lua-app APP=my_app

Agora você está pronto para começar a desenvolver seu app!

Próximos Passos

Continue para Conceitos Fundamentais para entender como os Apps Lua funcionam e como integrar com Jornadas.