Tabblad API-sleutels

Het tabblad API-sleutels is alleen beschikbaar als uw account is geabonneerd op RICOH Predictive Insight. Om het tabblad te kunnen zien en met sleutels te kunnen werken, moet u beschikken over toegang via Beheerder tot Account Administration.

Twee links bovenaan het tabblad openen referentie-informatie over de gegevensexport-API:

Aan de slag met API-sleutels

Hiermee opent u de helppagina voor de gegevensexport-API, waar u kunt lezen wat u moet doen om aan de slag te gaan met API-sleutels, evenals welke eindpunten beschikbaar zijn, welke velden elk eindpunt retourneert en welke limieten van toepassing zijn op verzoeken.

API-verkenner openen

Hiermee opent u de interactieve documentatiepagina voor de API, waar u elk eindpunt kunt bekijken, kunt zien welke parameters het accepteert en voorbeeldverzoeken rechtstreeks vanuit uw browser kunt verzenden. U hebt de waarde van een API-sleutel nodig om vanaf die pagina een verzoek in te dienen.

Dit zijn de acties die u op dit tabblad kunt uitvoeren:

• Bekijk alle sleutels die voor uw account zijn gedefinieerd, evenals de bijbehorende eigenschappen, zoals: Naam, Status en Vervaldatum.

  In de tabel wordt de waarde van een sleutel niet weergegeven.

• Maak een sleutel aan.

  Klik op API-sleutel maken. De codes zijn doorgaans binnen 30 seconden actief, maar er kunnen vertragingen optreden.

• Houd de API-verzoeken van het account in de gaten en controleer of deze binnen de limieten van het abonnement blijven.

  In het vak boven de tabel met API-sleutels worden het gebruiksabonnement van het account en het maximale aantal toegestane API-aanroepen per periode van 30 dagen weergegeven. Houd bij hoeveel telefoongesprekken er in de afgelopen 30 dagen zijn gevoerd.

• Wijzig de naam, de beschrijving of de vervaldatum van een bestaande sleutel.

  Klik met de rechtermuisknop op een rij en selecteer API-sleutel bewerken. Het bewerken van een sleutel heeft geen invloed op de waarde ervan, zodat toepassingen die de sleutel al gebruiken, gewoon blijven functioneren.

• Draai een sleutel om de waarde ervan te wijzigen.

  Klik met de rechtermuisknop op een rij en selecteer API-sleutel roteren. Stel een overlappingsperiode in, zodat zowel de huidige waarde als de nieuwe waarde nog een aantal dagen geldig blijven; dit geeft u de tijd om uw applicaties aan te passen. De sleutel met de nieuwe waarde is doorgaans binnen 30 seconden beschikbaar voor gebruik, maar er kunnen vertragingen optreden.

• Een sleutel verwijderen.

  Klik met de rechtermuisknop op een rij en selecteer Direct verwijderen.

  Opmerking:
  • Wanneer u een sleutel verwijdert, wordt deze binnen een minuut uit het systeem verwijderd, hoewel er vertragingen kunnen optreden. Verwijderde sleutels worden definitief verwijderd. Indien u probeert een API-verzoek te verzenden met een sleutel nadat u deze hebt verwijderd, mislukt het verzoek.
  • Als u een sleutel verwijdert, worden alle versies van die sleutel verwijderd. Als u een sleutel roteert en vervolgens verwijdert, worden beide versies van de sleutel verwijderd, zelfs als de overlappingsperiode nog steeds van kracht is.

Sleutels zijn niet beperkt tot afzonderlijke printers. Iedereen die over de waarde van een sleutel beschikt, kan verzoeken indienen namens uw account. Deel sleutels uitsluitend met de personen die integraties ontwikkelen, en vervang deze regelmatig in overeenstemming met uw beveiligingsprocedures.

Als u op , het hulpprogrammapictogram, klikt, wordt een menu geopend waarmee u de informatie in de tabel kunt vernieuwen en de tabelkolommen kunt beheren.