Olet tässä:
Integrointitoimenpiteen kutsu REST API -rajapinnoista
REST API:n avulla voit käyttää joko GET- tai POST-kutsuja kutsumaan integraatiotoimenpiteitä ja noutaaksesi tulokset. Ero näiden kahden välillä on, että GET-kutsu ei voi välittää dataa JSON-pyynnön tekstiosalla.
Kutsut REST-kutsua, jonka URL-osoite on muotoiltu näin:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/Nimitila on tavallisesti omnistudio. Määritä integraatiotoimenpiteen tyyppi ja alatyyppi.
Käytät parametrejä välittääksesi dataa integraatiotoimenpiteeseen kolmella tavalla:
-
Inline-arvoina URL-polussa (GET tai POST)
-
Kyselyparametri=arvo-parit liitetään URL-osoitteeseen (GET tai POST)
-
Määrittämällä JSON-pyynnön tekstiosan (vain POST)
Kun käytät integraatiotoimenpiteitä REST API:n kanssa, noudata seuraavia ohjeita:
-
JSON-notaatiossa karkaistut hakasulkeet ovat literaaleja. Ne erottelevat JSON-objektit.
-
REST-muuttujan URL-merkinnässä silmukkaiset hakasulkeet ympäröivät muuttuja-arvoja, jotka sinun täytyy korvata. Älä sisällytä hakasulkeita todelliseen pyyntöön.
-
Käsittele kaikkia REST URL -osoitteen osia merkkikokoriippuvaisina.
Voit myös määrittää Integrointitoimenpide-vaihtoehdot, kuten chainable tai queueableChainable, kyselyparametreinä REST-kutsulla:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?queueableChainable=trueEsimerkki REST-kutsusta integraatiotoimenpiteeseen on kohdassa Ketjutetun integraatiotoimenpiteen kutsuminen REST-kutsuilla.
- Integrointitoimenpiteen kutsu GET:n avulla
Lähetä GET-kutsu pyytääksesi ja vastaanottaaksesi JSON-datatuloksia integraatiotoimenpiteestä. GET-kutsun avulla voit määrittää upotetun URL-polun parametrejä ja liittää kyselyn parametrejä URL-osoitteeseen. Jos sinun täytyy välittää dataa JSON-pyynnön tekstiosalla, käytä sen sijaan POST-kutsuja. - Integrointitoimenpiteen kutsu POST:n avulla
Lähetä POST-kutsu lähettääksesi JSON-dataa ja vastaanottaaksesi tuloksia integraatiotoimenpiteestä. POST-kutsun avulla voit määrittää upotetun URL-polun parametrejä, liittää kyselyparametrejä URL-osoitteeseen ja lisätä JSON-pyynnön tekstiosan.
Integrointitoimenpiteen kutsu GET:n avulla
Lähetä GET-kutsu pyytääksesi ja vastaanottaaksesi JSON-datatuloksia integraatiotoimenpiteestä. GET-kutsun avulla voit määrittää upotetun URL-polun parametrejä ja liittää kyselyn parametrejä URL-osoitteeseen. Jos sinun täytyy välittää dataa JSON-pyynnön tekstiosalla, käytä sen sijaan POST-kutsuja.
Tässä esimerkissä tapauksia luova integrointitoimenpide vaatii yhteyshenkilön nimen ja palauttaa luodun tapauksen tunnuksen. Yhteyshenkilön nimi lisätään URL-osoitteeseen kyselyparametrinä. Arvo %20 on etu- ja sukunimen välinen URL-koodattu välilyönti.
-
GET URL:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?Contact=Dennis%20Reynolds -
Lopputulos:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
Tässä toisessa esimerkissä URL-osoitteen syntaksi näyttää tältä:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Voit kutsua URL-osoitetta näillä arvoilla:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXGET-kutsu lähettää tämän input-arvon integrointitoimenpiteeseen. URL-polussa välitetyt arvot lisätään JSON-tiedoston options-noodiin, jonka avaimet on nimetty PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}Integrointitoimenpiteen kutsu POST:n avulla
Lähetä POST-kutsu lähettääksesi JSON-dataa ja vastaanottaaksesi tuloksia integraatiotoimenpiteestä. POST-kutsun avulla voit määrittää upotetun URL-polun parametrejä, liittää kyselyparametrejä URL-osoitteeseen ja lisätä JSON-pyynnön tekstiosan.
Tässä esimerkissä tapauksia luova integrointitoimenpide vaatii yhteyshenkilön nimen ja palauttaa luodun tapauksen tunnuksen. Yhteyshenkilön nimi määritetään JSON-pyynnön tekstiosassa.
-
POST-URL:
/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/ -
POST JSON -data:
{ "Contact": "Dennis Reynolds" } -
Lopputulos:
{ "Case": { "Id": "0036100001HDn3QAAT" } }
Tässä toisessa esimerkissä URL-osoitteen syntaksi näyttää tältä:
/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}Voit kutsua URL-osoitetta näillä arvoilla:
/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneXPOST-kutsu lähettää tämän input-arvon integrointitoimenpiteeseen. URL-polussa välitetyt arvot lisätään JSON-tiedoston options-noodiin, jonka avaimet on nimetty PathN.
{
"options": {
"Path1": "Apple",
"Path2": "Phones",
"product": "iPhoneX",
"isDebug": "true"
}
}