Criar/Editar função para integração com APIs externas

curl --request POST \
  --url https://api.wppfy.com/function/edit \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "id": "<string>",
  "delete": true,
  "function": {
    "name": "createProduct",
    "description": "Cria um novo produto no catálogo",
    "method": "POST",
    "endpoint": "https://api.example.com/products",
    "isActive": false,
    "headers": {
      "Authorization": "Bearer {{apiKey}}",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "{{productName}}",
      "price": "{{price}}",
      "category": "{{category}}"
    },
    "parameters": [
      {
        "name": "apiKey",
        "type": "string",
        "description": "Chave de API para autenticação",
        "required": true
      },
      {
        "name": "price",
        "type": "number",
        "description": "Preço do produto",
        "minimum": 0.01,
        "maximum": 999999.99,
        "required": true
      }
    ]
  }
}
'

{
  "name": "<string>",
  "description": "<string>",
  "method": "<string>",
  "endpoint": "<string>",
  "id": "<string>",
  "active": false,
  "headers": "<string>",
  "body": "<string>",
  "parameters": "[]",
  "undocumentedParameters": "<string>",
  "header_error": false,
  "body_error": false,
  "owner": "<string>",
  "created": "strftime('%Y-%m-%d %H:%M:%fZ')",
  "updated": "strftime('%Y-%m-%d %H:%M:%fZ')"
}

Funções API dos Agentes

Criar/Editar função para integração com APIs externas

Configuração de Funções de API para Agentes IA

Documentação para criar/editar funções utilizadas pelos agentes de IA para integração com APIs externas. Inclui validação automática e controle de ativação.

1. Estrutura Base da Função

Campos Principais

{
  "name": "nomeDaFuncao",
  "description": "Descrição detalhada",
  "isActive": true,
  "method": "POST",
  "endpoint": "https://api.exemplo.com/recurso",
  "headers": {},
  "body": {},
  "parameters": []
}

Detalhamento dos Campos

`name`

Identificador único e descritivo
Sem espaços ou caracteres especiais
Ex: “createProduct”, “updateUserStatus”

`description`

Propósito e funcionamento da função
Inclua casos de uso e resultados esperados
Ex: “Cria produto no catálogo com nome, preço e categoria”

`isActive`

Controla disponibilidade da função
Desativa automaticamente se houver erros
Default: false

`method`

GET: buscar dados
POST: criar recurso
PUT: atualizar completo
PATCH: atualização parcial
DELETE: remover recurso

`endpoint`

URL completa da API
Aceita placeholders:

Exemplos:

https://api.exemplo.com/produtos
https://api.exemplo.com/usuarios/{{userId}}
https://api.exemplo.com/busca?q={{query}}&limit={{limit}}

`headers`

{
  "Authorization": "Bearer {{apiKey}}",
  "Content-Type": "application/json",
  "Accept": "application/json"
}

`body` (POST/PUT/PATCH)

{
  "name": "{{productName}}",
  "price": "{{price}}",
  "metadata": {
    "tags": "{{tags}}"
  }
}

2. Configuração de Parâmetros

Estrutura do Parâmetro

{
  "name": "nomeParametro",
  "type": "string",
  "description": "Descrição do uso",
  "required": true,
  "enum": "valor1,valor2,valor3",
  "minimum": 0,
  "maximum": 100
}

Tipos de Parâmetros

String

{
  "name": "status",
  "type": "string",
  "description": "Status do pedido",
  "required": true,
  "enum": "pending,processing,completed"
}

Número

{
  "name": "price",
  "type": "number",
  "description": "Preço em reais",
  "required": true,
  "minimum": 0.01,
  "maximum": 99999.99
}

Inteiro

{
  "name": "quantity",
  "type": "integer",
  "description": "Quantidade",
  "minimum": 0,
  "maximum": 1000
}

Boolean

{
  "name": "active",
  "type": "boolean",
  "description": "Status de ativação"
}

3. Sistema de Validação

Validações Automáticas

JSON

Headers e body devem ser válidos
Erros desativam a função

Placeholders ()

Case-sensitive
Devem ter parâmetro correspondente

Parâmetros

Nomes únicos
Tipos corretos
Limites numéricos válidos
Enums sem valores vazios

Erros e Avisos

Função desativa se houver:
- JSON inválido
- Parâmetros não documentados
- Violações de tipo
Erros aparecem em undocumentedParameters

4. Exemplo Completo

{
  "name": "createProduct",
  "description": "Criar novo produto no catálogo",
  "isActive": true,
  "method": "POST",
  "endpoint": "https://api.store.com/v1/products",
  "headers": {
    "Authorization": "Bearer {{apiKey}}",
    "Content-Type": "application/json"
  },
  "body": {
    "name": "{{productName}}",
    "price": "{{price}}",
    "category": "{{category}}"
  },
  "parameters": [
    {
      "name": "apiKey",
      "type": "string",
      "description": "Chave de API",
      "required": true
    },
    {
      "name": "productName",
      "type": "string",
      "description": "Nome do produto",
      "required": true
    },
    {
      "name": "price",
      "type": "number",
      "description": "Preço em reais",
      "required": true,
      "minimum": 0.01
    },
    {
      "name": "category",
      "type": "string",
      "description": "Categoria do produto",
      "required": true,
      "enum": "electronics,clothing,books"
    }
  ]
}

POST

function

edit

Criar/Editar função para integração com APIs externas

curl --request POST \
  --url https://api.wppfy.com/function/edit \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "id": "<string>",
  "delete": true,
  "function": {
    "name": "createProduct",
    "description": "Cria um novo produto no catálogo",
    "method": "POST",
    "endpoint": "https://api.example.com/products",
    "isActive": false,
    "headers": {
      "Authorization": "Bearer {{apiKey}}",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "{{productName}}",
      "price": "{{price}}",
      "category": "{{category}}"
    },
    "parameters": [
      {
        "name": "apiKey",
        "type": "string",
        "description": "Chave de API para autenticação",
        "required": true
      },
      {
        "name": "price",
        "type": "number",
        "description": "Preço do produto",
        "minimum": 0.01,
        "maximum": 999999.99,
        "required": true
      }
    ]
  }
}
'

{
  "name": "<string>",
  "description": "<string>",
  "method": "<string>",
  "endpoint": "<string>",
  "id": "<string>",
  "active": false,
  "headers": "<string>",
  "body": "<string>",
  "parameters": "[]",
  "undocumentedParameters": "<string>",
  "header_error": false,
  "body_error": false,
  "owner": "<string>",
  "created": "strftime('%Y-%m-%d %H:%M:%fZ')",
  "updated": "strftime('%Y-%m-%d %H:%M:%fZ')"
}

Authorizations

token

string

header

required

Body

application/json

string

required

ID da função. Vazio para criar nova, preenchido para editar existente.

delete

boolean

required

Se true, deleta a função especificada pelo ID.

function

object

required

Show child attributes

function.name

string

required

Nome da função

Example:

"createProduct"

function.description

string

required

Descrição detalhada da função e seu propósito

Example:

"Cria um novo produto no catálogo"

function.method

enum<string>

required

Método HTTP da requisição

Available options:

GET,

POST,

PUT,

DELETE,

PATCH

Example:

"POST"

function.endpoint

string

required

URL do endpoint da API

Example:

"https://api.example.com/products"

function.isActive

boolean

default:false

Status de ativação da função

function.headers

object

Cabeçalhos da requisição. Suporta placeholders no formato {{variavel}}

Example:

{
  "Authorization": "Bearer {{apiKey}}",
  "Content-Type": "application/json"
}

function.body

object

Corpo da requisição. Suporta placeholders no formato {{variavel}}

Example:

{
  "name": "{{productName}}",
  "price": "{{price}}",
  "category": "{{category}}"
}

function.parameters

object[]

Lista de parâmetros aceitos pela função

Show child attributes

function.parameters.name

string

required

Nome do parâmetro

function.parameters.type

enum<string>

required

Tipo do parâmetro

Available options:

string,

number,

integer,

boolean,

array,

object

function.parameters.description

string

required

Descrição do parâmetro

function.parameters.required

boolean

Indica se o parâmetro é obrigatório

function.parameters.enum

string

Lista de valores permitidos para parâmetros do tipo string, separados por vírgula

function.parameters.minimum

number

Valor mínimo para parâmetros numéricos

function.parameters.maximum

number

Valor máximo para parâmetros numéricos

Example:

[
  {
    "name": "apiKey",
    "type": "string",
    "description": "Chave de API para autenticação",
    "required": true
  },
  {
    "name": "price",
    "type": "number",
    "description": "Preço do produto",
    "minimum": 0.01,
    "maximum": 999999.99,
    "required": true
  }
]

Response

Função atualizada com sucesso

name

string

required

Nome da função

description

string

required

Descrição da função

method

string

required

Método HTTP da requisição

endpoint

string

required

Endpoint da API

string

ID único da função gerado automaticamente

active

boolean

default:false

Indica se a função está ativa

headers

string | null

Cabeçalhos da requisição

body

string | null

Corpo da requisição

parameters

string | null

default:[]

Parâmetros da função

undocumentedParameters

string

Parâmetros não documentados

header_error

boolean

default:false

Indica erro de formatação nos cabeçalhos

body_error

boolean

default:false

Indica erro de formatação no corpo

owner

string

Proprietário da função

created

string<date-time>

default:strftime('%Y-%m-%d %H:%M:%fZ')

Data de criação

updated

string<date-time>

default:strftime('%Y-%m-%d %H:%M:%fZ')

Data de atualização

List Knowledge Base Lista todas as funções de API

⌘I

Instance

Chatbot Configurations

CRM

Profile

Send Message

Message Actions and Search

Groups and Communities

Webhooks and SSE

AI Agent Configuration

Mass Messaging

Chatbot Trigger

Agents Knowledge

Funções API dos Agentes

Bloqueios

Etiquetas

Chats

Contatos

Respostas Rápidas

Chamadas

Integração Chatwoot

Authorizations

Body

Response