Verbinding configureren

Met Integration Hub-verbindingen kunt u integraties in webservices van derden instellen die u wilt gebruiken in CXone.

Voer de onderstaande taken in de aangegeven volgorde uit.

Een verbindingssjabloon maken

Een verbindingssjabloon definieert de basisinformatie over een integratie. Sjablonen worden gemaakt voor het maken van de verbindingen waar u specifieke verzoeken van andere informatie kunt configureren.

Verbindingssjablonen kunnen niet worden gewijzigd nadat u ze hebt gemaakt. Als u eventuele details moet wijzigen,inclusief de kopteksten, moet u een nieuwe sjabloon maken.

Screenshot van de pagina Sjabloon toevoegen in Integration Hub.
  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.
  2. Klik op Sjabloon toevoegen.
  3. Voer een Naam in voor de sjabloon op het tabblad Details.
  4. Voer de naam in van de applicatie waarmee u verbinding maakt. Dit kan een applicatie, platform of webservice zijn.
  5. Selecteer REST bij Integratiemethode. REST is momenteel de enige ondersteunde methode.

  6. Selecteer een optie voor Authenticatietype.

    Optie Details
    OAuth 2.0 Selecteer deze optie als u wilt dat de sjabloon OAuth 2.0 authenticatie zal bevatten. Dit is momenteel het enige ondersteunde authenticatietype.
    Geen auth. Selecteer deze optie als u niet wilt dat de sjabloon authenticatie zal bevatten.
  7. Voer een beschrijving van de sjabloon in. Andere gebruikers kunnen dit zien wanneer ze deze sjabloon selecteren vanaf de verbindingsbibliotheek.
  8. U kunt een pictogram toevoegen door een afbeelding te slepen en neer te zetten of door op Bestanden bladeren te klikken. Dit pictogram wordt weergegeven voor deze sjabloon in de verbindingsbibliotheek voor alle verbindingen die met deze sjabloon zijn gemaakt.
  9. Selecteer op het tabblad Configuratie de methoden (werkwoorden) die u beschikbaar wilt hebben voor gebruik met deze sjabloon. Niet alle webservices ondersteunen alle REST-werkwoorden.
  10. Om aangepaste authenticatiekopteksten te definiëren voor deze sjabloon, klikt u op Aangepaste koptekst toevoegen. Deze optie is alleen beschikbaar als u authenticatie hebt ingeschakeld voor de sjabloon. Een koptekst definiëren: 
    1. Voer de naam van de koptekst in het veld dat verschijnt in.
    2. Klik op Aangepaste koptekst toevoegen om meer aangepaste kopteksten toe te voegen.
    3. Selecteer Vereist? Voor eventuele kopteksten die moeten worden gebruikt in verbindingen die vanaf deze sjabloon zijn gemaakt.
    4. Klik op de X om een koptekst te verwijderen.
  11. Controleer alle instellingen opnieuw. U kunt een sjabloon niet verwerken nadat u deze hebt opgeslagen.
  12. Voer een van de volgende handelingen uit:
    • Klik op Pictogram van een disketteOpslaan om de sjabloon toe te voegen aan de bibliotheek Verbindingen.
    • Klik op Opslaan + Mijn verbindingen om de sjabloon toe te voegen aan de bibliotheek Verbindingen en maak een verbinding ervan. Nadat de verbinding is gemaakt, kunt u deze configureren door authenticatiedetails, variabelen of verzoeken toe te voegen. Uw verzoek kan een of alle configuraties bevatten.

Een verbinding maken

Met Verbindingen kunt u verzoeken maken en authenticatiedetails toevoegen. Verbindingen verschijnen onder Mijn verbindingen in Integration Hub. U kunt nieuwe verbindingen maken vanuit verbindingssjablonen. De verbindingsbibliotheek toont alle verbindingssjablonen die in uw CXone systeem aanwezig zijn. Als er geen sjabloon is die aansluit op wat u wilt doen, kunt u er een maken.

Als u een nieuwe verbinding wilt maken die op een bestaande lijkt, kunt u de bestaande verbinding ook kopiëren om tijd te besparen. Wanneer u een kopie van een bestaande verbinding maakt, bevat de nieuwe verbinding de URL, kopteksten, parameters, inhoud, time-outconfiguratie, namen van variabelen en geheime namen. De nieuwe verbinding bevat geen verzoeken van de oorspronkelijke verbinding, het clientcertificaat, sleutels, wachtwoordzinnen, varaibelenwaarden of geheime waarden.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Maak een nieuwe verbinding op een van de volgende manieren:

    • Als u een geheel nieuwe verbinding wilt maken, zoekt u een sjabloon in de verbindingsbibliotheek. De bibliotheek bevindt zich aan de rechterzijde van de pagina. Als u een verbinding of sjabloon weergeeft, klikt u op de X in de rechterbovenhoek van de pagina. Dit sluit de pagina zodat u de bibliotheek Verbindingen kunt zien. Klik op + Mijn verbinding op de pagina met sjablooneigenschappen om een verbinding te maken op basis van de sjabloon.

    • Als u een nieuwe verbinding wilt maken door een bestaande te kopiëren, zoekt u de gewenste verbinding in het paneel Mijn verbindingen aan de linkerkant en klikt u erop. Klik op Pictogram van twee gestapelde vellen papierKopiëren.

  3. Typ in het veld Mijn verbindingsnaam in het pop-upvenster een unieke naam voor de nieuwe verbinding.

  4. Klik op Pictogram van een disketteOpslaan.

Authenticatiedetails configureren

U kunt authenticatiedetails configureren op het tabblad Authenticatie in uw verbinding. Dit tabblad is alleen zichtbaar wanneer authenticatie is ingeschakeld in de sjabloon die wordt gebruikt voor deze verbinding.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Authenticatie.

  4. Voer de URL in die voor het authenticatieverzoek wordt gebruikt. De URL kan niet dynamisch zijn, maar u kunt wel naar de geheimen erin verwijzen.

  5. Selecteer de REST-methode (werkwoord) die wordt gebruikt in het authenticatieverzoek. De beschikbare werkwoorden zijn gedefinieerd door de sjabloon die wordt gebruikt voor deze verbinding.

  6. Voer onder Kopteksten de geschikte waarde in elk veld in. Velden met een sterretje ( * ) zijn verplicht. Deze velden zijn gedefinieerd in de sjabloon die wordt gebruikt voor deze verbinding.

  7. Om een aangepaste koptekst toe te voegen aan deze verbinding:

    1. Klik op Aangepaste koptekst toevoegen.

    2. Voer Naam koptekst en Koptekstwaarde in.

  8. Om een queryparameter toe te voegen aan het authenticatieverzoek: 
    1. Klik op Zoekopdrachtparameter toevoegen.
    2. Vul voor elke zoekopdrachtparameter die u toevoegt de velden Naam zoekopdrachtparameter en Waarde zoekopdrachtparameter in.

  9. Selecteer een mediatype en voer de inhoud in. Het mediatype beïnvloed de opmaak van de inhoud. Deze moet overeenkomen met het type dat vereist is door de autorisatieserver die u gebruikt.

    Optie Details

    ApplicationJson

    De inhoud moet in JSON zijn.
    ApplicationJsonPatch De inhoud moet in JSON patch-indeling zijn.
    FormURLEncoded

    De inhoud moet in sleutelwaardeparen zijn. Dit mediatype stuurt aanvragen met veelvoorkomende URL-notaties.

    Klik op +Parameter formulier toevoegen en voer de Parameternaam formulier en Parameterwaarde formulier in.
    TextHtml De inhoud moet in HTML zijn.
    TextPlain De inhoud moet in platte tekst zijn.
    TextXml De inhoud moet in XML zijn.

  10. Klik op Pictogram van een disketteOpslaan.

Een zelfondertekend certificaat voor mTLS-authenticatie configureren

Op het tabblad Configuratie van een verbinding kunt u de time-outinstelling en een zelfondertekend certificaat voor mTLS-authenticatie configureren.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Configuratie.

  4. Pas de instelling Time-out (MS) indien nodig aan. De time-out is van toepassing op elk verzoek dat is geconfigureerd in de verbinding, inclusief authenticatie. Als u een mTLS zelfondertekend certificaat gebruikt, vult u de volgende velden in.

    • Klantcertificaat
    • Persoonlijke sleutel klant
    • Sleutelwachtwoordzin

    Deze velden zullen alleen verschijnen als u OAuth 2.0 gebruikt als uw authenticatietype. U moet Klantcertificaat en Persoonlijke sleutel klant samen invoeren. Als uw Persoonlijke sleutel klant is gecodeerd, moet u ook een Sleutelwachtwoordzin invoeren. mTLS-certificaten zullen alleen werken als uw authenticatie-URL in HTTPS is. Validatie van deze velden zullen optreden nadat de verbinding is opgeslagen. U kunt deze velden raadplegen op het tabblad Geheimen.

  5. Klik op Pictogram van een disketteOpslaan.

Variabelen toevoegen aan een verbinding

Met Integration Hub -variabelen kunt u bepaalde informatie in een verbinding delen. U kunt bepalen of deze informatie gecodeerd wordt of niet. Een gecodeerde variabele (geheim) biedt een extra beveiligingslaag bij het gebruik van gevoelige informatie, zoals wachtwoorden in Studio-scripts.

Wanneer u een variabele maakt, kunt u deze op elk moment converteren naar een geheim. Nadat een variabele een geheim is geworden en de connector is opgeslagen, kunt u het geheim niet meer terugzetten naar een variabele.

Geheimen zijn niet omkeerbaar. Wanneer u weg klikt van het veld Geheime waarde, wordt de inhoud gecodeerd en vervangen door sterretjes die de inhoud verbergen ( * ). Er is geen manier om de waarde die u in het veld hebt ingevoerd, op te halen nadat het is verborgen.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Variabelen op + Variabele toevoegen.

  4. Voer voor de variabele een naam in waarmee duidelijk is wat de variabele bevat. Namen kunnen spaties of speciale tekens bevatten.

  5. Voer de waarde voor de variabele in. Dit is de waarde van de variabele en de informatie die wordt gecodeerd als u van de variabele een geheim maakt. Controleer dat de informatie correct is voordat u deze activeert als een geheim.

  6. Als u de variabele wilt coderen, schakelt u de schuifregelaar Geheim in.

  7. Als u een variabele wilt verwijderen uit de verbinding, klikt u op de X aan de rechterzijde ervan.

  8. Klik op Pictogram van een disketteOpslaan.

Variabelen gebruiken in een verbinding

U kunt variabelen gebruiken in handmatige verzoeken of Studio scriptverzoeken. U kunt deze gebruiken in kopteksten, zoekopdrachtparameters en inhoud.

Gebruik een variabele in authenticatiedetails of een handmatig verzoek

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad waar u een variabele wilt gebruiken. Variabelen kunnen worden gebruikt op de tabbladen Authenticatie en Verzoeken.

  4. Voer de variabele in op de plaats waar u de waarde van de variabele wilt. Volg hierbij deze richtlijnen:

    • Sluit de naam in tussen dubbele aanhalingstekens. Bijvoorbeeld [[ Naam_variabele ]].
    • Gebruik de naam exact zoals deze is ingevoerd in het veld Naam variabele op het tabblad Variabelen.
    • Variabelen kunnen alleen worden gebruikt met de verbinding waarmee ze zijn gemaakt.

Een variabele in een Studio-verzoek gebruiken

Om variabelen te gebruiken in een Studio-script, moet het script een CONNECTAuth- of CONNECTREQUEST-actie hebben. De actie moet het script koppelen met de verbinding die de variabele bevat.

  1. Open in Studio het script waarin u de variabele wilt gebruiken.

  2. Dubbelklik op de Snippet-actie waaraan u de variabele wilt toevoegen.

  3. Voeg in het Snippet-editorvenster de variabele in op de plaats waar u de waarde van de variabele wilt gebruiken. Volg hierbij deze richtlijnen:

    • Sluit de naam in tussen dubbele aanhalingstekens. Bijvoorbeeld [[ Naam_variabele ]].
    • Gebruik de naam exact zoals deze is ingevoerd in het veld Naam variabele op het tabblad Variabelen.
    • Sluit de vierkante haken en de naam van de variabele in tussen dubbele aanhalingstekens ("). Bijvoorbeeld "[[ Naam_variabele ]]". Als de variabele deel uitmaakt van een string, zoals een URL, moet de volledige string tussen dubbele aanhalingstekens staan en niet alleen de variabele. Bijvoorbeeld, "[[ Naam_variabele ]]/locatie/andere_locatie/".
    • Variabelen kunnen alleen worden gebruikt met de verbinding waarmee ze zijn gemaakt. De verbinding moet worden opgegeven in het script met een CONNECTAuth- of CONNECTREQUEST-actie.

    Voorbeelden:

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"

Een handmatig verzoek maken

Verzoeken zijn de manier waarop u de informatie verkrijgt die u nodig hebt van de webservice waarmee uw integratie verbinding maakt. U kunt handmatige verzoeken gebruiken in Studio-scripts of u kunt ze uitvoeren van Integration Hub.

Als uw aanvraag padparameters of een variabelenvervanging in de URL, kopteksten of parameters vereist, moet u een Studio-verzoek maken. Handmatige verzoeken ondersteunen deze opties niet.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Verzoeken op Verzoek toevoegen.

  4. Voer een Verzoeknaam in.

  5. Selecteer Handmatig als de Trigger.

  6. Voer de URL in voor dit verzoek.

  7. Klik op de-methode (werkwoord) voor dit verzoek.

  8. Voeg onder Kopteksten alle kopteksten toe die vereist zijn voor uw verzoek.

    1. Klik op Koptekst toevoegen.

    2. Voer Naam koptekst en Koptekstwaarde in.

  9. Voeg onder Zoekopdrachtparameters alle parameter toe die vereist zijn voor uw verzoek. 
    1. Klik op Zoekopdrachtparameter toevoegen.
    2. Voer een Zoekopdrachtparameternaam en een Zoekopdrachtparameterwaarde in.

  10. Selecteer een mediatype en voer de inhoud in. Het mediatype beïnvloed de opmaak van de inhoud. Dit moet overeenkomen met het type dat vereist is door de webservice waarmee u verbinding maakt.

    Optie Details

    ApplicationJson

    De inhoud moet in JSON zijn met applicatie/json als de inhoudkoptekst.
    ApplicationJsonPatch De inhoud moet in JSON Patch-indeling zijn met applicatie/json-patch+json als de inhoudkoptekst.
    FormURLEncoded

    De inhoud moet in sleutel-/waardeparen zijn met applicatie/x-www-form-urlencoded als de inhoudkoptekst. Dit mediatype stuurt aanvragen met veelvoorkomende URL-notaties.

    Klik op +Parameter formulier toevoegen en voer de Parameternaam formulier en Parameterwaarde formulier in.
    TextHtml De inhoud moet in HTML zijn met tekst/html als de inhoudkoptekst.
    TextPlain De inhoud moet in platte tekst zijn met tekst/plat als de inhoudkoptekst.
    TextXml De inhoud moet in XML zijn met tekst/xml als de inhoudkoptekst.
  11. Als u de actieve status van dit verzoek wilt wijzigen, klikt u op Actief bovenaan op de pagina. De tekst verandert naar Inactief.
  12. Klik op Bevestigen.
  13. Klik op het tabblad Verzoeken op Testen voor het verzoek dat u net hebt toegevoegd. Integration Hub probeert het verzoek. Een venster verschijnt en toont de resultaten van de test.
  14. Klik op Bewerken en breng wijzigingen aan het verzoek aan of klik op Pictogram van een disketteOpslaan .

Een Studio-verzoek maken

Een Studio-verzoek is handig wanneer u API-verzoeken hebt die niet kunnen worden gemaakt in Integration Hub, maar u Integration Hub wilt kunnen gebruiken voor authenticatie en geheimen.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Verzoeken op Verzoek toevoegen.

  4. Voer een Verzoeknaam in.

  5. Selecteer Studio als de Trigger.

  6. Selecteer en kopieer het voorbeeld voor verzoek payload vanaf de pagina Verzoek toevoegen als u het voorbeeld wilt gebruiken om de JSON in uw script te bouwen.

  7. Klik op Bevestigen.

    Studio-verzoeken kunnen niet worden getest vanaf Integration Hub. U moet ze testen in Studio door het script uit te voeren met een tracering.

  8. Klik op Pictogram van een disketteOpslaan.

  9. Start Studio en log in.
  10. Open een bestaand script of maak een nieuw script.
  11. Voeg een Snippet -actie toe aan uw script en dubbelklik erop om het Snippet-editorvenster te openen.

  12. Bouw een dynamisch object in het Snippet editorvenster en converteer het naar JSON. Het object dat u maakt, moet leden bevatten die de kopteksten, zoekopdracht en inhoud bevatten die vereist zijn voor het verzoek.

    Gebruik de voorbeeldpayload die u hebt gekopieerd van Integration Hub in een eerdere stap als een gids wanneer u een object aanmaakt. De voorbeeldpayload is:

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

    Een dynamisch object dat is gemaakt met de voorbeeldpayload als een gids, is:

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"
ASSIGN requestPayload.HTTPMETHOD = "POST"
ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"
ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"
ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"
ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    De laatste lijn van het voorgaande voorbeeld gebruikt de replace() -functie om het koppelteken ( - ) in te voegen in de CONTENT-TYPE-sleutelnaam. In Studio kunnen namen van variabelen geen speciale tekens bevatten, zoals koppeltekens. Deze benadering wordt dus gebruikt als een workaround.

  13. Configureer het script om het verzoek te gebruiken.

De status van een verzoek gebruiken

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. Verzoeken zijn standaard actief.

  1. Klik in CXone op de app-kiezer en selecteerAutomatisering & AI > Integration Hub.

  2. Klik op de verbinding waarmee u wilt werken vanaf Mijn verbindingen aan de linkerzijde van de pagina.

  3. Klik op het tabblad Verzoeken op het verzoek waarmee u wilt werken.

  4. Klik bovenaan de pagina op Inactief of Actief om de status te wijzigen.