Handleiding API (Bouwspecialisten)

Wat vind je in dit artikel?

• Samenvatting: Een kort overzicht van het activatieproces voor bouwspecialisten.

• Voorwaarden en doelgroep: Wat er vooraf geregeld moet zijn door 12Build Support.

• API Key genereren: Stappen om je persoonlijke sleutel aan te maken in je account.

• Authenticatie en aanroepen: Hoe je de API Key gebruikt om acties uit te voeren.

Samenvatting

Bouwspecialisten kunnen de API gebruiken nadat 12Build Support de functie en een specifieke gebruiker heeft geactiveerd. Na activatie genereer je zelf een API Key in je accountinstellingen, waarmee je een tijdelijk token opvraagt voor veilige gegevensuitwisseling.

Voorwaarden en doelgroep

Dit artikel is specifiek geschreven voor bouwspecialisten die 12Build willen koppelen aan hun eigen systemen.

• Activatie: De API-module moet eerst door 12Build Support worden aangezet. Stuur hiervoor een e-mail naar support@12build.com.

• Gebruikerstoegang: Support moet een specifieke gebruiker uit jouw contactenlijst aanwijzen als API-gebruiker. Alle acties via de API worden namens deze persoon uitgevoerd.

API Key genereren

Zodra 12Build Support de activatie heeft bevestigd, kun je de sleutel aanmaken.

1. Log in op je bedrijfsprofiel.

2. Klik rechtsboven op je gebruikersaccount en selecteer Mijn account. 
   

3. Klik in het menu op het tabblad API. 

4. Klik op de knop om een API Key te genereren. Deze unieke code heb je nodig voor de koppeling. 
   

Authenticatie en aanroepen

De API Key is de basis voor je technische koppeling.

1. Token opvragen: Gebruik de API Key om een token op te vragen.

2. Geldigheid: Dit token is precies één uur geldig.

3. Autorisatie: Stuur bij elke functie-aanroep het token mee in de header als: 'X-Auth-Token: '.$token.

4. Parameters:

   • Gebruik voor parameters van het type 'template' een GET-request in de URL.

   • Gebruik voor parameters van het type 'query' een POST-request.

Veelgestelde vragen (FAQ)

Vraag: Kan ik meerdere gebruikers aanwijzen voor de API? Antwoord: Nee, 12Build Support activeert één specifieke gebruiker uit je contacten. Alle API-acties worden geregistreerd onder de naam van deze gebruiker.

Vraag: Waar vind ik de technische details van de functies? Antwoord: De volledige lijst met functies, parameters en responses, evenals het Postman-bestand voor tests, vind je in de technische API-documentatie van 12Build.

Probleemoplossing

• Symptoom -> Ik zie het tabblad 'API' niet in mijn account.

  • Oorzaak -> De API-functionaliteit is nog niet geactiveerd door 12Build Support.

  • Oplossing -> Stuur een e-mail naar support@12build.com om de activatie aan te vragen.

• Symptoom -> Mijn token wordt niet geaccepteerd.

  • Oorzaak -> Het token is waarschijnlijk ouder dan een uur en dus verlopen.

  • Oplossing -> Vraag met je API Key een nieuw token aan en gebruik deze in de header van je volgende verzoek.