API-configuratie: De XML API inschakelen en aangepaste velden configureren

Beheer > API-configuratie

API :: Configuratie

XML API activeren

U kunt ervoor kiezen de Bomgar XML API in te schakelen, waardoor u rapporten kunt maken en opdrachten kunt geven zoals het starten of verplaatsen van sessies vanuit externe toepassingen of om automatisch een back-up van uw softwareconfiguratie te maken.

Toestemming voor HTTP-toegang tot XML API

Standaard is de toegang tot de API met SSL versleuteld. Maar u kunt ervoor kiezen niet-versleutelde HTTP-toegang toe te staan. Vanuit het oogpunt van beveiliging wordt sterk aanbevolen toegang via HTTP niet toe te staan.

Opmerking: Deze optie is vanaf versie 16.1 afgeschaft en verschijnt niet bij nieuwe gebruikers. De optie is nog wel beschikbaar voor gebruikers die upgraden van een versie voor 16.1 als u de afgeschafte verificatiemethode voor de API blijft gebruiken met een gebruikersaccount. Als u overstapt naar de aanbevolen verificatiemethode met een API-account, moet alle API-verkeer via HTTPS plaatsvinden.

API :: Accounts

In een API-account worden alle instellingen voor verificatie en autorisatie voor de API client opgeslagen. Om de API te gebruiken is ten minste één API-account vereist, ofwel in samenhang met de integratieclient, met een app van derden of met uw eigen intern ontwikkelde software.

Opmerking: Voorafgaand aan versie 16.1 werd een gebruikersaccount gebruikt voor verificatie met de API. Deze methode is afgeschaft, hoewel er voor klanten die deze methode al gebruiken nog wel ondersteuning is voor compatibiliteit met oudere versies.

Nieuwe API-account aanmaken, bewerken, verwijderen

Maak een nieuwe account aan, wijzig een bestaande account of verwijder een bestaande account.

API :: Account :: Toevoegen of bewerken

Naam

Maak een unieke naam aan om dit account te identificeren.

Opmerkingen

Voeg commentaar toe om aan te geven wat het doel is van dit object.

Ingeschakeld

Als deze optie is ingeschakeld, mag dit account verifiëren met de API. Als een account is uitgeschakeld, worden alle OAuth-tokens die bij het account horen onmiddellijk uitgeschakeld.

Machtigingen

Selecteer de gebieden van de API die deze account mag gebruiken. U kunt voor de Opdracht API toegang weigeren, alleen lezen toestaan of volledige toegang geven. Stel ook in of dit account de Rapportage-API, de Back-up-API en/of de API voor eindpunt-verificatiemanager kan gebruiken.

Netwerkbeperkingen

Lijst met voorvoegsels van netwerkadressen waarvandaan deze account kan worden geverifieerd.

Opmerking: API-accounts zijn niet beperkt door de netwerkadresvoorvoegsels op /login > Beheer > Beveiliging. Ze worden alleen beperkt door de netwerkadresvoorvoegsels die zijn geconfigureerd voor de API-account.

Verificatie-instellingen

De client-ID voor Oauth en het clientgeheim worden gebruikt om OAuth-tokens te maken. Deze zijn nodig voor het verifiëren bij de API. Raadpleeg de API-gids voor meer informatie.

OAuth client-ID

De OAuth client-ID is een uniek ID dat door het apparaat wordt gegenereerd. Het kan niet worden aangepast. De client-ID beschouwen we als openbare informatie en kan daarom worden gedeeld zonder de beveiliging van de integratie te compromitteren.

OAuth geheim van client

Het OAuth-clientgeheim wordt gegenereerd door het apparaat met gebruik van een veilig versleutelde pseudo-willekeurige nummergenerator.

Opmerking: Het clientgeheim kan niet worden aangepast, maar het kan wel opnieuw worden gegenereerd op de pagina Bewerken. Als een clientgeheim opnieuw wordt genereerd en als vervolgens de account wordt opgeslagen, worden alle OAuth-tokens die bij de account horen direct ongeldig. Alle API-oproepen met die tokens kunnen dan geen toegang tot de API verkrijgen.

API :: Aangepaste velden

Maak aangepaste API-velden aan om informatie over uw klant te verzamelen, waardoor u Bomgar beter kunt integreren met uw bestaande programma's. Aangepaste velden moeten in combinatie met de Bomgar-API worden gebruikt. Raadpleeg de API-gids voor meer informatie.

Nieuw veld aanmaken, bewerken, verwijderen

Maak een nieuw veld aan, wijzig een bestaand veld of verwijder een bestaand veld.

API :: Aangepaste velden :: Toevoegen of bewerken

Schermnaam

Maak een unieke naam aan om dit aangepaste veld te identificeren. De naam wordt in de toegangsconsole weergegeven als onderdeel van de sessiegegevens.

Codenaam

Stel een codenaam in voor integratiedoeleinden. Als u geen codenaam instelt, wordt er automatisch een aangemaakt.

Laat zien in de toegangsconsole

Als u Laat zien in de toegangsconsole aanvinkt, dan zijn dit veld en de waarde ervan zichtbaar telkens wanneer de sessiegegevens in de toegangsconsole worden weergegeven.