API-sleutel aanmaken

Een externe applicatie die gegevens uit LogicTrade ophaalt, doet dat via een API-sleutel. Je maakt die sleutel zelf aan in de backoffice. Dit artikel is bedoeld voor de beheerder. Je hebt het recht Beheer API nodig; zonder dat recht kun je de pagina niet openen.

API-sleutel aanmaken

1. Ga in de backoffice naar Beheer > API.
2. Blijf op het tabblad API. Het tabblad Product Configurator gaat over sleutels voor de product-configuratorkoppeling en valt buiten dit artikel.
3. Klik in de werkbalk op de plusknop om een sleutel toe te voegen.
4. Vul bij Omschrijving in waarvoor de sleutel bedoeld is, bijvoorbeeld de naam van de applicatie die hem gaat gebruiken. Dit veld is verplicht. Let op: de omschrijving kan na het opslaan niet meer worden gewijzigd.
5. Vink bij Scope aan welke gegevens de sleutel mag benaderen. Standaard zijn alle scopes ingeschakeld. Schakel scopes uit die de applicatie niet nodig heeft (principe van minimale rechten).
6. Klik op Opslaan.

Sleutel kopiëren voor je het venster sluit

Na het opslaan verschijnt de sleutel eenmalig in beeld, met daarboven een rode waarschuwing. Kopieer de sleutel direct en sla hem op in een wachtwoordmanager of de configuratie van de applicatie die hem gebruikt. Klik daarna pas op Sluiten.

Sluit je het venster zonder te kopiëren, dan is de sleutel niet meer op te vragen. In het overzicht zie je daarna alleen nog een afgeschermde versie. Er is geen manier om de sleutel opnieuw te tonen: maak in dat geval een nieuwe sleutel aan en trek de oude in.

Wat bepaalt de scope van een API-sleutel?

De scope legt vast welke soorten gegevens de sleutel mag gebruiken. Je kiest uit:

• Klant
• Leverancier
• Artikel
• Offerte
• Order
• Factuur
• Levering
• Inkooporder

Geef een sleutel alleen de scopes die de applicatie echt nodig heeft. Een koppeling die producten toont en offertes aanmaakt, heeft bijvoorbeeld genoeg aan Artikel en Offerte.

Overzicht van je sleutels lezen

Op het tabblad API staat per sleutel een regel met Omschrijving, Key in afgeschermde vorm, Scope, Aanmaakdatum en Actief. Sleutels gelden per administratie: wat je hier aanmaakt, werkt alleen voor de administratie waarin je op dat moment werkt.

Hoe pas je de scope van een bestaande sleutel aan?

1. Dubbelklik op de regel van de sleutel, of selecteer hem en klik in de werkbalk op de bewerkknop.
2. Vink de scopes aan of uit die je wil wijzigen. De omschrijving staat vast.
3. Klik op Opslaan.

De sleutel zelf verandert hierdoor niet. De applicatie die hem gebruikt, blijft dus gewoon werken met minder of meer rechten.

Hoe trek je een API-sleutel in?

1. Selecteer de sleutel in het overzicht.
2. Klik in de werkbalk op de verwijderknop.
3. Bevestig de actie in het bevestigingsvenster dat verschijnt.

Trek een sleutel in zodra een koppeling wordt gestopt, of als je vermoedt dat de sleutel in verkeerde handen is gevallen. Trek de sleutel ook in als een medewerker met toegang tot de sleutel de organisatie verlaat. Een ingetrokken sleutel is onmiddellijk ongeldig.

Let op: zie je de melding dat de sleutelbeheerdienst niet bereikbaar is, dan kun je op dat moment geen sleutels bekijken, aanmaken of wijzigen. Probeer het later opnieuw. Bestaande sleutels blijven gewoon werken.

Een voorbeeld van een koppeling die deze sleutel gebruikt, staat in Visualisatie en offerte maken met Unlit Vision.

Kom je er niet uit? Neem contact met ons op.