API-sleutel aanmaken

Een externe applicatie die gegevens uit LogicTrade haalt, doet dat met een API-sleutel. Die maak je zelf aan in de backoffice. Dit artikel is voor de beheerder. Je hebt het recht Beheer API nodig; zonder dat recht kom je niet op de pagina.

API-sleutel aanmaken

1. Ga in de backoffice naar Beheer > API.
2. Blijf op het tabblad API. Het tabblad Product Configurator gaat over andere sleutels.
3. Klik in de werkbalk op de plusknop om een sleutel toe te voegen.
4. Vul bij Omschrijving in waar de sleutel voor is, bijvoorbeeld de naam van de applicatie die hem gaat gebruiken. Dit veld is verplicht en kan later niet meer worden gewijzigd.
5. Vink bij Scope aan welke gegevens de sleutel mag benaderen. Standaard staat alles aan.
6. Klik op Opslaan.

Sleutel kopiëren voor je het venster sluit

Na het opslaan verschijnt de sleutel één keer in beeld, met daarboven een rode waarschuwing. Kopieer de sleutel meteen en zet hem in de applicatie die hem nodig heeft. Klik daarna pas op Sluiten.

Sluit je het venster zonder te kopiëren, dan is de sleutel weg. In het overzicht zie je daarna alleen nog een afgeschermde versie. Er is geen manier om hem opnieuw te tonen: je maakt dan een nieuwe sleutel aan en trekt de oude in.

Wat de scope bepaalt

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.

Scope van een bestaande sleutel aanpassen

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.

Sleutel intrekken

1. Selecteer de sleutel in het overzicht.
2. Klik in de werkbalk op de verwijderknop.
3. Bevestig dat je de sleutel wil intrekken.

Trek een sleutel in zodra een koppeling stopt of als je vermoedt dat de sleutel bij de verkeerde persoon terecht is gekomen. Een ingetrokken sleutel werkt direct niet meer.

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.