Integration Hub

Integration Hub biedt een centrale plek voor het beheren van integraties met externe systemen en diensten. Hiermee kunt u gestandaardiseerde RESTAPI Application Programming Interface. Hiermee kunt u bepaalde functies automatiseren door uw CXone Mpower-systeem te koppelen aan andere software.-verbindingen maken, die u in meerdere Studio scripts kunt gebruiken. Dit voorkomt dat u steeds dezelfde verzoeken opnieuw hoeft op te bouwen wanneer u extern via een API wilt communiceren. In plaats daarvan kunt u het verzoek één keer in Integration Hubsamenstellen en het vervolgens hergebruiken waar u het nodig hebt. Dit vereenvoudigt en versnelt het scriptproces.

Integration Hub maakt uw integraties ook veiliger. Het versleutelt API-gegevens, zodat ze niet telkens in het script worden weergegeven wanneer je ze gebruikt. Studio scripts worden opgeslagen als platte tekst, daarom kunt u belangrijke inloggegevens niet veilig als variabelen rechtstreeks in het script opslaan, zoals tokens die worden gebruikt voor API-verzoeken. MetIntegration Hub kunt u snel een authenticatieverzoek aan een script toevoegen en vervolgens de verkregen referenties veilig gebruiken in volgende API-aanroepen. Je kunt ook mTLS-certificaten toevoegen aan een API-verzoek.

Integration Hub maakt deel uit van de Automatisering & AI app in CXone Mpower. Als je de Automatisering en AI starten-machtiginghebt, kun je de app vanuit CXone Mpower in een nieuw venster openen en op Integration Hubklikken.

Verbindingen

Verbindingen definiëren de details voor integratie met een externe service, zoals API-verzoeken, authenticatiestromen en variabelen. Je zou bijvoorbeeld een verbindingssjabloon kunnen maken voor Salesforce. Dit zou de basisgegevens definiëren die nodig zijn om verbinding te maken met Salesforce, zoals het authenticatietype en de ondersteunde methoden. Vanuit deze sjabloon kunt u een verbinding tot stand brengen, waarmee u specifieke gegevens uit de sjabloon kunt invullen, samen met meer specifieke details zoals de specifieke API-verzoeken die u naar Salesforcewilt sturen.

VerbindingssSjablonen

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 uitgevoerd met de verbonden webservice, zoals het ophalen van gegevens (GET) of het maken van records (POST).

Een verbinding hoeft niet alle types verbindingsgegevens te bevatten. Dit kan elke mogelijke combinatie zijn van de ondersteunde types informatie.

Alle verbindingssjablonen zijn beschikbaar in de verbindingsbibliotheek in Integration Hub. Sjablonen die u kunt gebruiken in een Studio-script staan ​​vermeld onder Mijn Verbindingen in Integration Hub. Je kunt maximaal 50 verbindingen aanmaken (in de lijst 'Mijn Verbindingen'). Er is geen limiet aan het aantal sjablonen in de verbindingsbibliotheek.

Alle sjablonen 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.

SysteemsSjablonen

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. Momenteel bevat Integration Hub één systeemsjabloon:

• CXone Mpower Dev Portal: Integreert met API-eindpunten die zijn gedocumenteerd op de CXone Mpower Developer Portal . Dit is 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.

Verzoeken

Verzoeken zijn API-oproepen. Voor elke verbinding in de lijst 'Mijn Verbindingen' kunt u verzoeken toevoegen die u wilt gebruiken met de specifieke externe service. Deze verzoeken specificeren de volgende informatie, die wordt gebruikt om verbinding te maken 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.
• Queryparameters: Een manier om informatie door te geven met een API-aanvraag in de eindpunt-URL. 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: text/xml
  • Sigv4: applicatie/ x-amz-json-1.1

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.

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 versleuteld opgeslagen in een versleutelde database. Integration Hub gebruikt de AES-standaard (Advanced Encryption Standard) voor het coderen van de gegevens. 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:

• CONNECTAUTH: met deze actie kunt u authenticatiedetails of geheimen opnemen in uw scripts. De authenticatiedetails en variabelen moeten worden gedefinieerd in een Integration Hub-verbinding.
• CONNECTREQUEST: met deze actie kunt u een verzoek gebruiken dat is gedefinieerd in een Integration Hub-verbinding. Deze actie is vereist voor het gebruik van handmatige verzoeken en Studio-verzoeken.

Belangrijke informatie over Integration Hub Studio-acties

• Ze vereisen Integration Hub. Als Integration Hub niet is ingeschakeld in uw CXone Mpower-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 Mpower, 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.

Stroomonderbreker

Integration Hub heeft een ingebouwde stroomonderbreker. Het is een voorzorgsmaatregel voor mislukte API-aanroepen. Als de circuit breaker detecteert dat een oproep herhaaldelijk mislukt, wordt deze geactiveerd en wordt de API-oproep beperkt. De meest voorkomende reden voor mislukte oproepen is een tijdelijke serverfout (500 fouten). Door het gesprek te vertragen (of te pauzeren) krijgt de server de tijd om weer op te starten en correct te functioneren.

De belangrijkste kenmerken van de stroomonderbreker zijn:

• De stroomonderbreker activeert als meer dan 50% van de oproepen naar een API mislukt binnen de 30 seconden.

• Om de stroomonderbreker te activeren, moet Integration Hub meer dan 100 oproepen naar één API hebben geprobeerd binnen een frame van 30 seconden.

• De stroomonderbreker wordt geactiveerd gedurende 30 seconden.

• Redenen voor fouten zijn toegankelijk in de traceerlogboeken, vastgelegd in de variabele _err.Studio

Auditgeschiedenis

Elke verbinding in Integration Hub heeft een wijzigingslogboek. Elke keer dat er een verbinding wordt gemaakt of bijgewerkt, worden de volgende gegevens vastgelegd:

• Datum: De datum waarop de wijziging is aangebracht.

• Gewijzigd door: Wie heeft de wijziging aangebracht?

• Profielnaam: De naam van de verbinding.

• Actie: Wat er is gebeurd, bijvoorbeeld of er een verbinding is gemaakt of gewijzigd.

Gebruikers kunnen dit logboek openen via een nieuwe knop Audit in de verbindingsinstellingen.