Você está aqui:
Invocação do procedimento de integração de APIs REST
Com uma API REST, você pode usar uma chamada GET ou POST para invocar um Procedimento de integração e recuperar o resultado. A diferença entre as duas é que uma chamada GET não pode passar dados com um corpo de solicitação JSON.
Você chama uma chamada REST com um URL formatado assim:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/O namespace geralmente é omnistudio. Especifique o Tipo e o Subtipo do Procedimento de integração.
Você usa parâmetros para passar dados para um Procedimento de integração de três maneiras:
-
Como valores em linha no caminho do URL (GET ou POST)
-
Como parâmetro de consulta=valor são anexados ao URL (GET ou POST)
-
Especificando um corpo de solicitação JSON (somente POST)
Ao usar um Procedimento de integração com uma API REST, siga estas diretrizes:
-
Na notação JSON, chaves curvas são literais. Eles delimitam objetos JSON.
-
Na notação de URL REST, chaves cruzadas delimitam valores de variável que você deve substituir. Não inclua as chaves em uma solicitação real.
-
Trate todas as partes do URL REST como diferenciando maiúsculas de minúsculas.
Você também pode definir as opções de Procedimento de integração, como chainable ou queueableChainable, como parâmetros de consulta com uma chamada REST:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?queueableChainable=truePara obter um exemplo de chamada REST para um Procedimento de integração, consulte Invocar um Procedimento de integração encadeável com chamadas REST.
- Invocação do procedimento de integração usando GET
Para solicitar e receber resultados de dados JSON de um Procedimento de integração, emita uma chamada GET. Com uma chamada GET, você pode especificar parâmetros de caminho de URL em linha e acrescentar parâmetros de consulta ao URL. Se você precisar passar dados com um corpo de solicitação JSON, use uma chamada POST. - Invocação do procedimento de integração usando POST
Para enviar dados JSON e receber resultados de um Procedimento de integração, emita uma chamada POST. Com uma chamada POST, você pode especificar parâmetros de caminho de URL em linha, acrescentar parâmetros de consulta ao URL e incluir um corpo de solicitação JSON.
Invocação do procedimento de integração usando GET
Para solicitar e receber resultados de dados JSON de um Procedimento de integração, emita uma chamada GET. Com uma chamada GET, você pode especificar parâmetros de caminho de URL em linha e acrescentar parâmetros de consulta ao URL. Se você precisar passar dados com um corpo de solicitação JSON, use uma chamada POST.
Neste exemplo, um Procedimento de integração que cria casos requer um nome de Contato e retorna o ID do caso recém-criado. O nome do contato é anexado ao URL como um parâmetro de consulta. O valor %20 é o espaço codificado em URL entre o primeiro nome e o sobrenome.
-
OBTER URL:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?Contact=Dennis%20Reynolds -
Resultado:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
Neste segundo exemplo, a sintaxe do URL fica assim:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Você pode chamar o URL com estes valores:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXA chamada GET envia essa entrada ao Procedimento de integração. Os valores passados no caminho do URL são adicionados sob o nó options do JSON, com chaves chamadas PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}Invocação do procedimento de integração usando POST
Para enviar dados JSON e receber resultados de um Procedimento de integração, emita uma chamada POST. Com uma chamada POST, você pode especificar parâmetros de caminho de URL em linha, acrescentar parâmetros de consulta ao URL e incluir um corpo de solicitação JSON.
Neste exemplo, um Procedimento de integração que cria casos requer um nome de Contato e retorna o ID do caso recém-criado. O nome do Contato é especificado em um corpo de solicitação JSON.
-
URL POST:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/ -
POST JSON data:
{ "Contact": "Dennis Reynolds" } -
Resultado:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
Neste segundo exemplo, a sintaxe de um URL é semelhante a esta:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Você pode chamar o URL com estes valores:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXA chamada POST envia essa entrada ao Procedimento de integração. Os valores passados no caminho do URL são adicionados sob o nó options do JSON, com chaves chamadas PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}