Hoe maak ik een API-sleutel aan als gebruiker?

Wat vind je in dit artikel?

• Samenvatting: Een kort overzicht van het aanmaakproces van een API-sleutel.

• Voorwaarden en doelgroep: Voor wie deze functie bedoeld is en wat je vooraf nodig hebt.

• Stappenplan API-sleutel aanmaken: De route in het menu naar je nieuwe sleutel.

• Authenticatie: Hoe je de aanvraag veilig bevestigt.

• Sleutel kopiëren en opslaan: Belangrijke instructies over het eenmalig inzien van de code.

Samenvatting

Een API-sleutel stelt je in staat om handmatige taken, zoals het importeren van projectdata, te automatiseren. Je maakt deze sleutel aan in je accountinstellingen, bevestigt dit via een extra beveiligingsstap en kopieert de code direct voor gebruik in je bedrijfssoftware.

Voorwaarden en doelgroep

Dit artikel is bedoeld voor individuele gebruikers die gemachtigd zijn om koppelingen te maken met externe software of rapportagetools. Zorg dat de API-functionaliteit voor jouw organisatie en gebruikersprofiel is geactiveerd door een beheerder of 12Build Support.

Stappenplan API-sleutel aanmaken

Het aanmaken van een sleutel start in je persoonlijke profielinstellingen.

1. Klik rechtsboven in het scherm op je accountnaam.

2. Selecteer in het menu de optie API.

3. Klik op de knop API-sleutel toevoegen.
   

Authenticatie

Om de veiligheid van je account te waarborgen, vraagt het systeem om een bevestiging van deze actie.

1. Geef je nieuwe API-sleutel een herkenbare naam (bijvoorbeeld de naam van het systeem dat je koppelt).

2. Kies een methode om de actie te bevestigen:

   • Vul je wachtwoord in.

   • Bevestig de actie via de link in de e-mail die je ontvangt. 
     

Sleutel kopiëren en opslaan

Zodra de actie is bevestigd, verschijnt je unieke API-sleutel in een pop-up.

1. Selecteer de volledige sleutel met je muis.

2. Kopieer de code direct (gebruik hiervoor CTRL + C).

3. Belangrijk: Sla de sleutel direct op een veilige plek op. Zodra je de pop-up sluit, kun je deze specifieke code niet meer terughalen of opnieuw inzien. 
   

Veelgestelde vragen (FAQ)

Vraag: Kan ik meerdere API-sleutels aanmaken? Antwoord: Ja, door je sleutels een eigen naam te geven, kun je verschillende koppelingen onafhankelijk van elkaar beheren en indien nodig per stuk intrekken.

Vraag: Wat moet ik doen als ik de pop-up heb gesloten zonder de sleutel te kopiëren? Antwoord: Omdat de sleutel uit veiligheidsoverwegingen slechts eenmalig wordt getoond, moet je de betreffende sleutel verwijderen en een nieuwe aanmaken via de bovenstaande stappen.

Probleemoplossing

• Symptoom -> De knop 'API-sleutel toevoegen' is grijs of niet zichtbaar.

  • Oorzaak -> De API-rechten zijn nog niet toegekend aan jouw gebruikersprofiel.

  • Oplossing -> Vraag je (sub)beheerder om de API-functie voor jouw account te activeren onder de gebruikersinstellingen.

• Symptoom -> Ik ontvang geen e-mail voor de authenticatie.

  • Oorzaak -> De e-mail is mogelijk gemarkeerd als spam of er is een vertraging in de verzending.

  • Oplossing -> Controleer je ongewenste e-mail of kies voor de optie om te bevestigen met je wachtwoord.