Parámetros y autenticación
Defina qué debe enviar el modelo, cómo llegan los valores a su punto de conexión y cómo protegerlo con una clave o un token.
Parámetros
En la página de la herramienta, Parameters enumera lo que debe aportar el modelo. Elija Add parameter y rellene:
| Campo | Significado |
|---|---|
| Name | Por ejemplo order_id. Debe coincidir con cualquier {order_id} de la URL o de la plantilla del cuerpo. |
| Type | string, number, integer o boolean. |
| Description | «What this is, in words the model can act on», por ejemplo «The order number the caller read out». |
| Required | Si está marcado, la llamada se rechaza cuando el modelo lo omite. |
Antes de cada solicitud, Phynxa comprueba los argumentos del modelo: los obligatorios deben estar presentes, los valores deben ajustarse a su tipo (un «doce» hablado enviado como texto a un integer se rechaza con un mensaje del que el modelo puede recuperarse) y se descarta todo lo que el modelo invente y no esté definido.
Plantilla del cuerpo
Para POST, PUT y PATCH, el Body template le permite dar forma al JSON. Escriba JSON válido y use marcadores {name}:
{
"orderId": "{order_id}",
"channel": "voice-agent",
"note": "{note}"
}Los marcadores se escapan, de modo que quien llama no puede salirse de una cadena diciendo unas comillas. Si la plantilla no es JSON válido tras la sustitución, la herramienta informa «Body template is not valid JSON».
Autenticación
En Authentication, elija un Type:
| Tipo | Qué envía Phynxa |
|---|---|
| None | Nada adicional. |
| API key | El secreto en una cabecera o en un parámetro de consulta que usted nombre. Fije Sent as en Header o Query parameter y Name en, por ejemplo, X-Api-Key. |
| Bearer token | Authorization: Bearer <secret>. |
| OAuth token | Authorization: Bearer <secret> (un token que usted pega; Phynxa no ejecuta el flujo de OAuth para las herramientas). |
La página dice «The secret is stored on the server and never sent back to this page.» Para sustituirlo, escriba uno nuevo. Si deja el campo vacío, se conserva el almacenado.
Límites
- Timeout: hasta 30 segundos, por defecto 5. «The caller waits in silence, so keep this short.»
- Attempts: de 1 a 5. «Only timeouts and server errors are retried.» Las solicitudes que modifican algo (POST y PATCH) nunca se reintentan, de modo que una reserva no pueda hacerse dos veces.
Prueba
Use Test con un valor real. Consulte Pruebe y diagnostique herramientas.
Guías relacionadas
¿Algo de esto no coincide con lo que ve en el panel? Avísenos.