Usted está aquí:
Invocación de procedimientos de integración desde las API de REST
Con una API de REST, puede utilizar una llamada GET o POST para invocar un Procedimiento de integración y recuperar el resultado. La diferencia entre ambos es que una llamada GET no puede pasar datos con un cuerpo de solicitud JSON.
Invoca una llamada de REST con una URL con el formato siguiente:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/El espacio de nombres es normalmente omnistudio. Especifique el tipo y el subtipo del procedimiento de integración.
Utiliza parámetros para pasar datos a un procedimiento de integración de tres formas:
-
Como valores en línea en la ruta de URL (GET o POST)
-
Como pares parámetro=valor de consulta anexados a la URL (GET o POST)
-
Especificando un cuerpo de solicitud JSON (solo POST)
Cuando utilice un procedimiento de integración con una API de REST, siga estas directrices:
-
En notación JSON, los corchetes son literales. Delimitan objetos JSON.
-
En la notación de URL de REST, los corchetes rodean valores de variable que debe sustituir. No incluya los aparatos en una solicitud real.
-
Trate todas las partes de la URL de REST como que distinguen entre mayúsculas y minúsculas.
También puede establecer opciones de Procedimiento de integración como chainable o queueableChainable como parámetros de consulta con una llamada de REST:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?queueableChainable=truePara obtener un ejemplo de una llamada de REST a un procedimiento de integración, consulte Invocar un procedimiento de integración encadenable con llamadas de REST.
- Invocación de procedimientos de integración utilizando GET
Para solicitar y recibir resultados de datos JSON desde un procedimiento de integración, emita una llamada GET. Con una llamada GET, puede especificar parámetros de ruta de URL en línea y anexar parámetros de consulta a la URL. Si debe pasar datos con un cuerpo de solicitud JSON, utilice una llamada POST en su lugar. - Invocación de procedimiento de integración utilizando POST
Para enviar datos JSON y recibir resultados desde un Procedimiento de integración, emita una llamada POST. Con una llamada POST, puede especificar parámetros de ruta de URL en línea, anexar parámetros de consulta a la URL e incluir un cuerpo de solicitud JSON.
Invocación de procedimientos de integración utilizando GET
Para solicitar y recibir resultados de datos JSON desde un procedimiento de integración, emita una llamada GET. Con una llamada GET, puede especificar parámetros de ruta de URL en línea y anexar parámetros de consulta a la URL. Si debe pasar datos con un cuerpo de solicitud JSON, utilice una llamada POST en su lugar.
En este ejemplo, un Procedimiento de integración que crea casos requiere un nombre Contacto y devuelve el Id. del caso recién creado. El nombre Contacto se anexa a la URL como un parámetro de consulta. El valor %20 es el espacio codificado por URL entre el nombre y los apellidos.
-
URL GET:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?Contact=Dennis%20Reynolds -
Resultado:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
En este segundo ejemplo, la sintaxis de la URL tiene el siguiente aspecto:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Puede llamar a la URL con estos valores:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXLa llamada GET envía esta entrada al Procedimiento de integración. Los valores pasados en la ruta de URL se agregan bajo el nodo options del JSON, con claves denominadas PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}Invocación de procedimiento de integración utilizando POST
Para enviar datos JSON y recibir resultados desde un Procedimiento de integración, emita una llamada POST. Con una llamada POST, puede especificar parámetros de ruta de URL en línea, anexar parámetros de consulta a la URL e incluir un cuerpo de solicitud JSON.
En este ejemplo, un Procedimiento de integración que crea casos requiere un nombre Contacto y devuelve el Id. del caso recién creado. El nombre Contacto se especifica en un cuerpo de solicitud JSON.
-
URL POST:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/ -
Datos POST JSON:
{ "Contact": "Dennis Reynolds" } -
Resultado:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
En este segundo ejemplo, la sintaxis de una URL tiene el siguiente aspecto:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Puede llamar a la URL con estos valores:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXLa llamada POST envía esta entrada al Procedimiento de integración. Los valores pasados en la ruta de URL se agregan bajo el nodo options del JSON, con claves denominadas PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}