Toevoegen

<< Click to Display Table of Contents >>

Navigation:  AXITO Startmenu > Configuratie AXITO > API-beheer >

Toevoegen

Door de keuze Toevoegen te selecteren, wordt onderstaand toevoegscherm getoond.

clip0665

 

Afhankelijk van de API-code die u invult, worden:

Automatisch een aantal velden ingevuld die u best niet aanpast.

Andere (blanco) velden dienen echter nog ingevuld te worden.

 

Voor iedere API kunnen we een aantal instellingen configureren. Welke dit zijn bespreken we hieronder.

clip0667

 

 

Licentie- en dossiernummer

Een API kan gelinkt worden aan een specifieke licentiehouder en dossier. Ook kan een API gelinkt worden aan enkel maar een licentiehouder. Alle dossiers van die licentiehouder kunnen dan automatisch deze API gebruiken.

 

Overzicht

Licentiehouder EN

dossiernummer ingevuld

Deze API kan enkel vanuit het ingestelde dossier van deze licentiehouder worden aangeroepen.

Licentiehouder ingevuld

(dossiernummer niet)

Deze API ken vanuit elke dossier dat behoort bij de licentiehouder worden aangeroepen

Licentiehouder en

dossiernummer NIET ingevuld

Deze API kan vanuit ieder dossier worden aangeroepen.

 

API-Code

Door de gewenste API-code in te vullen, worden automatisch een groot aantal velden automatisch ingevuld. Via de F5 toets of door te klikken op de Pijl-knop krijgt u een overzicht van de beschikbare API-codes.

Afhankelijk van de geselecteerde API-code dient u nog bijkomende velden aan te passen.

API-url

Deze wordt automatisch ingevuld nadat u een API-code heeft geselecteerd. We adviseren u om dit niet te wijzigen, dit kan immers de communicatie verstoren (met fouten tot gevolg).

Communicatiemethode

Afhankelijk van de geselecteerde API-code wordt deze automatisch ingevuld. We adviseren u om dit niet te wijzigen, dit kan immers de communicatie verstoren (met fouten tot gevolg).

API-url domain, API-versie, API-taal

Deze velden kunnen afhankelijk van de geselecteerde API-code worden opgevraagd. De ingevulde waarde wordt nadien in de API-url ingevuld. De APi-url kan een aantal specifieke parameters bevatten, die worden vervangen door deze ingevulde velden

 

API-Parameter

Omschrijving

{API_DOMAIN}

Dit is meestal het (sub)domain van die is toegekend aan deze specifieke gebruiker. Bij een webshop kan dit bijvoorbeeld 'myshop' zijn:

https://{API_DOMAIN}.myshopify.com

httpd://myshop.myshopify.com

{API_VERSION}

Een API evolueert meestal. Er worden mogelijkheden toegevoegd, gewijzigd of weg gelaten. Na iedere grote wijziging wordt daarom altijd de versie-nummer aangepast, zodat we er zeker van zijn dat we de API aanspreken met de correcte mogelijkheden.

{API_LANGUAGE}

Sommige API's hebben de mogelijkheid om de data die ze terug geven, in een gewenste taal te doen.

{API_KEY}

Bij sommige API's wordt de api-key ook opgenomen in de API-url.

{VIN}

Enkel voor de garage-versie

Het VIN-nummer (chassisnummer) kan in de API-url worden ingevuld, om op die manier informatie van het betreffende voertuig aan te vragen.

{PLATE}

Enkel voor de garage-versie

Het Plate-nummer (nummerplaat) kan in de API-url worden ingevuld, om op die manier informatie van het betreffende voertuig aan te vragen.

{REQUEST_LIST}

Enkel voor de garage-versie

Voor de InMotiv-api moet mee gegeven worden welke data we wensen te ontvangen. Dit wordt gedaan via een aantal codes die we kunnen instellen via de keuze '\ URL-parameters'

 

Authenticatiemethode

Dit veld wordt automatisch ingevuld wanneer u de API-code heeft geselecteerd. Ook dit veld moet u niet wijzigen.

Momenteel worden volgende methodes ondersteund:

API-Key

Basic authenticatie

Bearer token

OAuth 2.0

API-key, Account naam , Wachtwoord, URL-Authenticatie, URL-Token, URL-Redirect, URL-Dev.portal

Afhankelijk van de gekozen authenticatie-methode worden deze velden wel of niet opgevraagd. Voor het instellen van deze waardes kunt u best contact opnemen met onze helpdesk.

Credits actief

Sommige communicaties met partners zijn betalend, en wordt de afrekening via AXITO geregeld. Afhankelijk van het contract dat u heeft, kan er worden gewerkt met credit (vb 100 aanvragen per maand). Hiervoor krijgt u maandelijks een aantal credits, en als deze op zijn, stopt de communicatie. U krijgt op tijd een waarschuwing dat de credits bijna op zijn zodat u desnoods credits kunt bijkopen.

Voor verdere uitleg verwijzen we u naar Credits beheren.

Activiteit logging

Via de activiteit logging wordt bijgehouden hoeveel communicaties er werden gemaakt. Dit kan zeer ruim of tot in detail worden ingesteld.