Criando Mini-App (1.0)
Para criar um aplicativo, siga as etapas 1 a 6 na imagem acima.
Para criar um aplicativo, siga as etapas 1 a 6 na imagem acima.
Na página de edição (esquerda), liste um título, descrição, logotipo, capa, ID do vídeo do YouTube e ele aparecerá assim na mini-app store (direita):
No lado direito da página de edição:
Você sempre pode usar dados de amostra na parte inferior para orientação. E os campos do sistema são o que você pode usar em seu código JSON, se necessário.
Autenticação
Este bloco serve para configurar autenticações do seu App.
Parâmetros
Exemplo de verificação de e-mail
Este é um exemplo de autenticação com uma chave API na consulta. Veja a seguir como ficará depois que os usuários instalarem o aplicativo:
A "chave API" definida pelos usuários será então armazenada na variável "token".
Exemplo de autenticação básica
{
"type": "APIKEY",
"params": [
{
"name": "sid",
"title": "Twilio Account SID:"
}，
{
"name": "token",
"title": "Twilio Auth Token:"
}
],
"connection": {
"headers": {
"Authorization": "Basic [[sid]]:[[token]]"
}
}
}
Outros exemplos
Exemplo 1: APIKEY Auth, cabeçalhos
{
"type": "APIKEY",
"params": [
{
"name": "token",
"title": "Enter your api key:"
}
],
"connection": {
"headers": {
"Authorization": "Bearer [[token]]"
}
}
}
Os "cabeçalhos" na "conexão" serão adicionados a cada solicitação, para que você não precise repeti-los em todos os lugares posteriormente.
Exemplo 2: APIKEY Auth, parâmetros de consulta
{
"type": "APIKEY",
"params": [
{
"name": "api_key",
"title": "Enter your api key:"
}
],
"connection": {
"qs": {
"key": "[[api_key]]"
}
}
}
Assim como acima, a string de consulta será adicionada a cada solicitação.
Exemplo 3: Autenticação APIKEY, token JWT
{
"type": "APIKEY",
"params": [
{
"name": "email",
"title": "Enter your email:"
},
{
"name": "api_key",
"title": "Enter your api key:"
}
],
"request": {
"url": "https://example.com/get-token",
"method": "POST",
"body_format": "form",
"cache": 3600, //cache this request for 3600 seconds
"payload": {
"email": "[[email]]",
"api_key": "[[api_key]]"
},
"mapping": [
{
"name": "token",
"path": "$.data.token"
}
]
},
"connection": {
"headers": {
"Authorization": "Bearer [[token]]"
}
}
}
O email e api_key fornecidos pelos usuários serão enviados como solicitação. Em seguida, as respostas serão mapeadas para a variável tokenpelo caminho JSON $.data.token. Depois disso, é usado como variável [[token]]em um cabeçalho de autorização. Novamente, o cabeçalho será adicionado a cada solicitação posteriormente.
Ações
Ações são as funções/recursos que os usuários podem realizar com seu aplicativo. Por exemplo, este aplicativo "Google Translate" possui 2 ações, "Detectar idioma" e "Traduzir texto":
Na área de codificação, é necessário definir as informações padrão da ação, incluindo nome, título, descrição, formulários e solicitações para que a ação funcione no fluxo com configuração.
Na parte inferior, clique em “Obter produto” para um exemplo de solicitação GET e em “Atualizar produto” para um exemplo de solicitação POST. O tipo de formulários e solicitações são objetos, portanto necessita definir vários atributos.
Parâmetros
Objeto de formulário
Linhas na variável de texto
Objeto de solicitação
{"Content-Type": "application/json"}Objeto de mapeamento
Exemplo de verificação de e-mail
A seguir está a codificação do exemplo de verificação de e-mail e as etapas da UI em ação.
Código:
IU do aplicativo:
Outros exemplos
Exemplo 1:
{
"url": "https://translation.googleapis.com/language/translate/v2/detect",
"method": "POST",
"headers": {
"Content-Type": "application/json"
},
"payload": {
"q": "[[q]]"
},
"mapping": [
{
"name": "language",
"type": "text",
"title": "Detected Language",
"path": "$.data.detections.0.0.language"
}
]
}
Exemplo 2:
{
"url": "https://example/api/auth",
"method": "POST",
"body_format": "form",
"cache": 3600,
"payload": {
"email": "[[email]]",
"api_key": "[[api_key]]"
},
"mapping": [
{
"name": "token",
"type": "text",
"title": "Token",
"path": "$.data.token"
}
]
}
Fontes
O bloco Sources é usado para fornecer aos usuários uma lista de opções para o valor do formulário. Use o nome da fonte no parâmetro de formulário no bloco Actions para construir a conexão.
Existem 2 formatos de fontes, static e dynamic. As opções de uma fonte estática são fixas enquanto uma fonte dinâmica traz opções variáveis de acordo com as entradas.
Parâmetros
Mapeando Objeto no Objeto Solicitação
pathresultados. Este é o valor real retornado quando um rótulo é selecionadopathresultados. Exibido na lista suspensa como rótuloExemplos
Formulários no bloco Ações:
"forms": [
{
"name": "static_options",
"type": "select",
"title": "Static Options",
"source": "product_type_list"
},
{
"name": "dynamic_options",
"type": "select",
"title": "Dynamic Options",
"source": "users_list"
}
]
Bloco de fontes:
[
{
"name": "product_type_list",
"type": "enum:static",
"list": [
{
"value": "food",
"label": "Food & Drink"
},
{
"value": "toy",
"label": "Toys"
},
{
"value": "phone",
"label": "Mobile Phone"
}
]
},
{
"name": "users_list",
"type": "enum:rpc",
"request": {
"url": "https://jsonplaceholder.typicode.com/users",
"method": "GET",
"headers": {
"Content-Type": "application/json"
},
"mapping": [
{
"type": "select",
"path": "$",
"value": "$.id",
"label": "$.username"
}
]
}
}
]
IU do aplicativo:
Gatilhos
Ao definir gatilhos, os usuários podem usar os gatilhos da seção de automação como qualquer outro gatilho integrado mostrado na captura de tela acima.
Observe que o nome do gatilho deve ser:
- em minúsculas
- único na lista de gatilhos
- sem espaço, você pode separar as palavras por sublinhados
Contexto é onde você lista todas as variáveis predefinidas quando os dados chegam.
Após definir o gatilho, você precisará configurar as "Solicitações de token de API" e selecionar a API em "Escopos da API", veja orientação abaixo.
Para chamar esse gatilho, consulte API para gatilho de miniaplicativo.
Escopos da API
Em "Api Scopes", selecione todas as APIs que seu mini-app precisa acessar. Verifique a "Documentação da API" através do link na parte superior.
Por exemplo, se seu aplicativo precisar visualizar a lista de tags dos usuários no fluxo, selecione "Visualizar tags de fluxo". Além disso, se você precisar usar gatilhos em seu aplicativo, selecione “App Trigger” na imagem acima.
Solicitações de token de API
Em "Solicitações de token de API", clique nos dados de amostra "Solicitações" na parte inferior e edite o endereço URL do seu endpoint para assinatura e cancelamento de assinatura. Além disso, verifique na parte inferior os campos do sistema disponíveis e coloque as informações necessárias na carga útil. Por exemplo, inclua "app_token" na carga útil se precisar acessar o fluxo dos usuários via API (se você selecionar qualquer API no bloco Api Scopes).
Salvar e testar
Por fim, clique em “Salvar” para finalizar a criação. Parabéns!! Você acabou de criar um miniaplicativo com sucesso.💯💯
Se você estiver usando o aplicativo apenas em seu próprio espaço de trabalho, não será necessário publicá-lo. Você pode testá-lo e usá-lo em qualquer bot de qualquer canal do seu espaço de trabalho.
Para compartilhar o aplicativo com outros espaços de trabalho, você precisará publicá-lo na mini-app store do NicoChat.