Rest Api Action

Rest Api Action icon

Behandelt RESTful API-oproepen synchroon. Door deze actie kan het systeem hogere werklasten verwerken. De actie retourneert zowel de inhoud als kopteksten voor de API-oproep. Dit maakt het gemakkelijker om scripts te testen en te debuggen.

Om een script te testen dat een REST API-optie bevat en responsinformatie weer te geven, moet u het script uitvoeren. Voer het script uit met de optie Starten met traceren.

U kunt ook synchrone REST API-oproepen maken met de functie GetRestProxy in een SNIPPET-actie. Deze optie heeft geen hoge belasting zoals de REST API-actie.

Dependencies

Er zijn beperkingen op het gebruik van deze actie. Beperkingen worden opgelegd op het niveau van de bedrijfseenheidGesloten Een organisatorische eenheid die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone-omgeving te beherentenant, zodat ze elkaar niet beïnvloeden. De beperkingen in de platform zijn:

  • Antwoordindeling: alleen de JSON-indeling wordt ondersteund.
  • Herhalingen bij mislukking: de actieverwerker zal het automatisch twee keer proberen als er een foutbericht wordt ontvangen voordat het antwoord wordt geretourneerd.
  • Time-out: specificeer de time-outwaarde in het verzoek. Maximaal 90 seconden.
  • Maximale responsgrootte: de maximale responsgrootte is 32 KB. Dit is in overeenstemming met de bestaande Snippet-functionaliteit.
  • Vertragingslimiet: de vertragingslimiet wordt bepaald door twee parameters:
    • Max. gelijktijdige verzoeken: tot 100 gelijktijdige verzoeken zijn standaard toegestaan. Deze limiet is dezelfde voor alle klanten van CXone. Dit betekent dat 100 gelijktijdige verzoeken resulteren in een veel hogere doorvoer dan de bestaande Snippet-functionaliteit. Als u meer dan 100 gelijktijdige verzoeken nodig hebt, overleg dan met uw CXone-accountmanager over het verhogen van de limiet voor uw bedrijfseenheid. Dit vereist speciale goedkeuringen.
    • Aantal in wachtrij: wanneer het aantal verzoeken de limiet overschrijdt, worden de extra verzoeken in een verwerkingswachtrij gezet. Wanneer het aantal verzoeken onder de limiet is gekomen, worden verzoeken uit de wachtrij gehaald voor verwerking.
  • Stroomonderbreker: als de opgegeven URL niet beschikbaar of niet bereikbaar is, kan uw verzoek te veel fouten opleveren. Als dit gebeurt, zal CXone de uitvoering van verzoeken onderbreken (d.i. Verminderen) van alle URL's van de REST API-actie voor een bepaalde periode. Hierdoor kan de URL herstellen van de storing. De limieten worden hieronder aangegeven.
    • Onderbrekingstijd of Pauzetijd: als het ingestelde foutpercentage wordt bereikt, worden geen verzoeken van de REST API-actie uitgevoerd gedurende 30 seconden.
    • Minimale doorvoer: 100 verzoeken per seconde. Als uw bedrijfseenheid minder dan dit minimum aantal verzoeken uitvoert, zal de uitvoering van uw verzoeken niet worden onderbroken, ook al mislukken de verzoeken.
    • Foutpercentage: als gedurende 30 seconden 50% van de verzoeken zijn mislukt, worden uw verzoeken de volgende 30 seconden niet uitgevoerd. 30 seconden is een rollend venster.

Input Properties

Deze eigenschappen definiëren gegevens die de actie gebruikt bij het uitvoeren.

Vertakking

Beschrijving

bijschrift toe

Voer een korte woordgroep in die deze actie in het script uniek identificeert. Het bijschrift verschijnt op het scriptcanvas onder het actiepictogram. The default is the action name.

Verb

Ondersteunt eenvoudige REST-acties zoals GET, PUT, POST, DELETE en PATCH.
Parameters

Maakt het mogelijk om queryparameters op te geven of gegevens te posten. Elk type JSON (Jobject , Jarray, Jtoken) zou acceptabel moeten zijn. Momenteel vereist de actie dat JSON-strings op één regel worden verstrekt. Variabelesubstitutie van JSON-strings of conversie van dynamische gegevenstypen naar JSON met behulp van de asjson() functie worden ondersteund. U kunt ook de uitvoervariabele resultSet(out) van een eerdere REST API-actie doorgeven aan deze eigenschap.
Headers

Ondersteunt de mogelijkheid om aangepaste headers toe te voegen voor klantauthenticatie (zoals bearer-tokens). Sleutel/waarde-paren in JSON-indeling worden geaccepteerd. Deze actie vereist dat JSON-strings in één regel wordt verstrekt. Variabelesubstitutie van JSON-strings of conversie van dynamische gegevenstypen naar JSON met behulp van de asjson()-functie wordt ondersteund. U kunt ook de uitvoervariabele resultSet(out) van een eerdere REST API-actie doorgeven aan deze eigenschap.

Belangrijk: Als uw aangepaste URL-eindpunt verschillende headers vereist, moet dit in deze eigenschap worden opgegeven. Om de functionaliteit op gelijk niveau te houden met de huidige Snippet-actie, voegt CXone de volgende headers toe.

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

De enige optie is MakeRestRequest met dezelfde functionaliteit als bij gebruik in een Snippet action. In de toekomst kunnen er nog meer opdrachten van de Snippet-actie worden ondersteund.

TimeOutInMilliSeconds

Hiermee kan een timeout voor de REST-aanroep worden ingesteld en toegepast. De waarde moet minder dan 90 seconden (90000 milliseconden) zijn. Als er geen time-out is opgegeven, is de standaard 10 seconden (10000 milliseconden).
Service Address

Hiermee kan een aangepaste URL worden opgegeven, met de mogelijkheid om queryparameters voor een GET op te geven. Variabelesubstitutie wordt ook ondersteund.

Uitvoereigenschappen

Deze eigenschappen bevatten variabelen die gegevens bevatten die worden geretourneerd na het uitvoeren van de actie. Ze zijn beschikbaar voor referentie en gebruik wanneer de actie wordt voltooid.

Vertakking

Beschrijving

resultSet(out)

De eigenschap die eventuele informatie bevat die is geretourneerd van de API die is opgegeven in Serviceadres. In het Studio-traceringsvenster wordt dit als Dynamic Object weergegeven voor weergavedoeleinden. U kunt dit resultSet desgewenst ook ongewijzigd doorgeven aan de koptekst en parameters.

errorArgList(out)

Foutvoorwaarden hebben een object zoals de REST-proxy ten behoeve van de compatibiliteit. Ondersteunt het DynamicData-type.

Resultaatvertakkingsvoorwaarden

Met Resultaatvertakkingsvoorwaarden kunt u vertakkingen maken in uw script om verschillende resultaten te behandelen wanneer de actie wordt uitgevoerd.

Voorwaarde

Beschrijving
Throttle

Het pad dat wordt gevolgd als er te veel aanvragen binnen een korte periode zijn. Zie het gedeelte Beperkingen voor meer informatie.
InvalidInput

Het pad dat wordt gevolgd als er ongeldige invoer wordt aangetroffen of als er een timeoutfout optreedt. Elke parameter wordt gevalideerd wanneer het script wordt opgeslagen.
Failure

Het pad dat wordt gevolgd als er een fout of uitzondering optreedt terwijl de NICE CXone applicatie de aanvraag uitvoert.
Error

Het pad dat wordt gevolgd als het externe eindpunt van de klant een HTTP-foutcode retourneert.
Default

Het pad dat wordt gevolgd als het antwoord niet binnen 90 seconden wordt ontvangen.
Success

Het pad dat wordt gevolgd als de actie zonder fouten is voltooid en eventuele API-aanroepen of geretourneerde gegevens succesvol waren (2xx responscodes).

Other Options

U kunt externe RESTful API-verzoeken vervangen die momenteel worden uitgevoerd in de Snippet action.