Integration Hub

Deze pagina heeft betrekking op een product of functie in Controlled Release. Als u geen deel uitmaakt van de CR-groep en meer informatie wilt, neem dan contact op met uw CXone-accountmanager.

Integration Hub biedt een gestandaardiseerde manier om de integratie te behandelen van CXone met externe authenticatie- en webservices. Webservices kunnen toepassingen, platforms of systemen zijn.

Integration Hub is een van de manieren waarop u kunt werken met REST API-oproepen in CXone. Het voordeel van het gebruik Integration Hub is, dat u de verbinding kunt toevoegen en deze kunt gebruiken op meerdere plaatsen. Andere methoden vereisen dat u bij elk gebruik een verbinding tot stand moet brengen.

Daarnaast biedt Integration Hub geavanceerde beveiliging, waaronder MTLS en geheimen. Gegevens die worden toegevoegd als geheimen, worden gecodeerd en zijn niet direct toegankelijk.

Integration Hub, toont de lijst Mijn verbindingen links en de bibliotheek Verbindingen aan de rechterkant.

Verbindingen en verbindingssjablonen

Verbindingen definiëren de details van API-verzoeken, authenticatiedetails en variabelen die u wilt gebruiken in CXone.  Een verbinding hoeft niet alle types verbindingsgegevens te bevatten. Dit kan elke mogelijke combinatie zijn van de ondersteunde types informatie.

Elke verbinding die u toevoegt aan Integration Hub wordt aangemaakt op basis van een verbindingssjabloon. Sjablonen definiëren de basisinformatie die van toepassing is op alle verbindingen die zullen worden gemaakt met de sjabloon. Dit bevat:

  • De naam van de webservice waarmee u verbinding maakt.
  • De integratiemethode. REST API is is momenteel de enige ondersteunde methode.
  • Het type authenticatie als die er is. U kunt momenteel kiezen tussen OAuth 2.0 of geen authenticatie.
  • De aangepaste kopteksten voor authenticatie, als er nodig zijn.
  • De werkwoorden die beschikbaar zijn voor gebruik op verzoeken die zijn ingediend op basis van de sjabloon. Werkwoorden zijn de acties die kunnen worden ondernomen met de verbonden webservice, zoals het ophalen van gegevens of het maken van records.

Integration Hub heeft twee typen sjablonen: systeemsjablonen die eigendom zijn van NICE en sjablonen die u zelf maakt. Systeemsjablonen worden geleverd bij Integration Hub en kunnen niet worden verwijderd. Deze acties zijn beschikbaar:

  • NICE CXone Dev Portal: integreert met eindpunten die beschikbaar zijn in API Developer Portal om uw afhankelijkheid van Studio Framework-acties te verminderen. Het maakt gebruik van OAuth 2.0-authenticatie. Om authenticatie te bepalen, maakt het gebruik van Discovery URL. Het biedt geen ondersteuning voor clientcertificaten.

Systeemsjablonen en sjablonen die u hebt gemaakt, kunnen niet worden gewijzigd. U kunt uw aangepaste sjablonen echter verwijderen. Als u later iets moet wijzigen in een aangepast sjabloon, kunt u de sjabloon verwijderen en een nieuwe maken. De verbindingen zelf kunnen worden gewijzigd. Het verwijderen van een sjabloon heeft geen invloed op de verbindingen die met die sjabloon zijn gemaakt.

Sjablonen zijn beschikbaar in de bibliotheek Verbindingen in Integration Hub. Verbindingen worden weergegeven onder Mijn verbindingen in Integration Hub. U kunt maximaal 50 verbindingen maken. Er is geen limiet op het aantal sjablonen.

Verzoeken

Verzoeken zijn API-oproepen. Ze specificeren de volgende informatie die wordt gebruikt voor het verbinden met een webservice.

  • URL: de locatie van de bron waarmee u verbinding maakt.
  • Methode (Werkwoord): de actie die het verzoek moet uitvoeren, zoals het ophalen van gegevens of het maken van een nieuwe record. Integration Hub ondersteunt deze werkwoorden: OPHALEN, PLAATSEN, POST, VERWIJDEREN, TRACEER, PATCH, KOP, OPTIES. De werkwoorden die beschikbaar zijn voor gebruik in een verbinding, zijn gedefinieerd in de sjabloon die wordt gebruikt voor het maken van de verbinding.
  • Kopteksten: een deel van het verzoek dat extra informatie over het verzoek bevat. Dit kan de taal, referenties enz. bevatten.
  • Zoekopdrachtparameters: een manier om informatie door te geven binnen een API-verzoek. Deze zijn geconfigureerd als sleutelwaardeparen. Ze kunnen worden gebruikt voor het filteren, sorteren, aanpassen of beheren van de gegevens die zijn geretourneerd in de respons.
  • Inhoud: de inhoud van het verzoek. De indeling is afhankelijk van de vereisten van de API waarmee u verbinding maakt.  Het mediatype van de inhoud moet overeenkomen met wat het materiaal waarmee u verbinding maakt, verwacht. Dit is ook bekend als het MIME-type of inhoudstype. Dit zijn de ondersteunende opties en de gekoppelde inhoudkopteksten:
    • ApplicationJson: applicatie/json
    • ApplicationJsonPatch: applicatie/json-patch+json
    • FormURLEncoded: applicatie/x-www-form-urlencoded
    • TextHtml: tekst/html
    • TextPlain: tekst/plat
    • TextXml: tekst/xml

Elke Integration Hub verbinding kan maximaal 50 verzoeken hebben. Er is geen beperking aan het aantal verzoeken dat op een bepaald ogenblik actief kan zijn.

CXone heeft een limiet van 32 KB op de grootte van reacties. Gebruik zoekopdrachtparameters voor het filteren van de geretourneerde gegevens. Dit kan u helpen om onder die limiet te blijven:

Handmatig en Studio-verzoeken

Integration Hub ondersteunt twee opties voor verzoeken in verbindingen:

  • Handmatig: een handmatig verzoek wordt opgemaakt in Integration Hub met de opties op de pagina Verzoek toevoegen. Hierin kunt u geheimen gebruiken. Handmatige verzoeken worden vaak gebruikt voor casussen waar de gegevens niet veranderen. Ze kunnen direct worden uitgevoerd vanaf Integration Hub zonder een Studio-script te vereisen. Ze kunnen ook worden uitgevoerd in Studio-scripts.

  • Studio: in sommige gevallen, kunnen geen API-aanroepen worden opgebouwd als handmatige verzoeken in Integration Hub. Verzoeken die bijvoorbeeld padparameters of variabele vervanging vereisen, of die verbinding maken met de SOAP-webservices, moeten worden gebouwd in een Studio-script. U wilt deze verzoeken mogelijk bijhouden in uw Integration Hub-verbindingen. Met de Studio-verzoekoptie kunt u dat doen. Een Studio-verzoek verschijnt op het tabblad Verzoeken, samen met alle handmatige verzoeken die de verbinding heeft.

Variabelen

Met Integration Hub kunt u waardeparen opslaan als variabelen. Variabelen worden standaard gedecodeerd. U kunt echter een variabele coderen door hiervan een geheim te maken. Door een variabele te markeren als een geheim, voegt u beveiliging toe aan gevoelige informatie, zoals wachtwoorden of sleutels.

Variabelen kunnen worden gebruikt in de verbinding waar u ze maakt. Als u een verbinding of authenticatieverzoek uitvoert in een Studio-script, kunt u variabelen gebruiken van die verbinding in het script.

Geheimen worden gecodeerd wanneer niet in transit. Integration Hub gebruikt de AES-standaard (Advanced Encryption Standard) voor het coderen van de gegevens. Dit wordt opgeslagen in een gecodeerde database. De enige keer dat de gegevens worden gedecodeerd, is op het ogenblik van de uitvoering.

Integration Hub Studio-acties

Wanneer u authenticatie wilt gebruiken of een verzoek wilt indienen in een Studio-script, moet u de volgende Studio-acties gebruiken:

Belangrijke informatie over Integration Hub Studio-acties

  • Ze vereisen Integration Hub. Als Integration Hub niet is ingeschakeld in uw CXone-systeem, werken de acties niet.
  • U kunt meer dan één instantie van elke actie in een script opnemen.
  • U kunt een variabelenvervanging gebruiken voor het uitvoeren van verschillende verzoeken of authenticatie gebruiken van meer dan één verbinding in één script.
  • Net als met andere methoden voor het maken van API-oproepen in CXone, is het schrijven van extra scripts vereist voor het ontvangen van het antwoord van de verbonden webservice en het correct omgaan ermee.
  • CONNECTAUTH staat geen aanpassing toe. Dit voert het verificatieverzoek uit zoals gedefinieerd in de verbinding in Integration Hub.