API-applicaties

Met de functie ACD-configuratie > API-applicaties in de ACD applicatie kunt u API-applicaties registreren. Deze functie genereert een ID, die u nodig hebt om een token aan te vragen voor gebruik in alle API-aanroepen. Zonder dit token kunt u geen API-aanroepen doen.

Wanneer u een API-applicatie registreert, toont CXone twee opties voor het Applicatietype: Interne applicatie registreren en Externe applicatie autoriseren. De optie Interne applicatie registreren is standaard ingeschakeld en u kunt dit niet wijzigen. Dit betekent dat u alleen uw eigen API-applicaties kunt registreren, die u zelf hebt geschreven. Als u een externe applicatie wilt autoriseren die door NICE CXone of een andere leverancier is gemaakt, neemt u contact op met uw CXone-accountmanager.

Een API-applicatie registreren

Vereiste machtigingen: API-applicaties Maken

U kunt API-applicaties registreren in de ontwikkelaarsportal of in ACD zoals aangegeven in de stappen hieronder.

Afbeelding van het API-registratieformulier

  1. Klik op de app-kiezer en selecteer ACD.
  2. Ga naar ACD-configuratie > API-applicaties.
  3. Klik op Nieuwe maken.
  4. Voer de Naam van leverancier en een Naam van applicatie in.

  5. Schakel de API-scopes in voor uw applicatie. Behalve als u de applicatie voor een specifieke API-scope maakt, dient u alle opties voor API-scope te selecteren.

  6. Voer in het veld Geautoriseerde callback-URL's een locatie in waar de antwoorden naartoe gestuurd moeten worden wanneer u een impliciete tokenaanvraag doet. Dankzij de impliciete tokenaanvraag kunt u rechtstreeks naar NICE CXone linken, zodat de applicatie u kan authenticeren zonder toegang te krijgen tot uw inloggegevens. Druk op + als u meer URL's wilt toevoegen. U kunt maximaal vijf callback-URL's per applicatie instellen.

  7. Klik op API-applicatie maken.

De status van een externe applicatie monitoren

Vereiste machtigingen: API-applicaties Bewerken

Gebruik het tabblad Applicatie monitoren van een API-applicatie als u de prestaties van de applicatie wilt controleren. U kunt maximaal 10 sleutelparameters laten monitoren om de prestaties van de applicatie te bewaken. U gebruikt bijvoorbeeld de parameter UCResponse om te controleren hoe lang het duurt om gegevens op te halen bij de UC-provider.

Afbeelding van het aanmaakformulier voor parameters op het tabblad Applicatie monitoren voor de externe API-applicatie

  1. Klik op de app-kiezer en selecteer ACD.
  2. Ga naar ACD-configuratie > API-applicaties.
  3. Klik op een externe applicatie om die te openen.
  4. Klik op het tabblad Applicatie monitoren.
  5. Schakel het selectievakje Applicatie monitoren in.
  6. Klik op Parameter toevoegen.
  7. Voer een Parameternaam in.
  8. Stel het Parametertype in op Getal of String.

  9. Voer waarden in voor elk van deze drempelwaarden: Normaal, Waarschuwing, Fout en Kritiek.

    U kunt de drempelwaarden van de parameter UCResponse bijvoorbeeld instellen op 5 seconden voor Normaal, 10 voor Waarschuwing, 15 voor Fout en 20 voor Kritiek. De status van de applicatie wordt in het gedeelte Hartslagdrempels weergegeven wanneer de drempelwaarden worden bereikt.

  10. Klik op Maken.