API-configuratie

API's configureren in Dastra

API staat voor Application Programming Interface;

API's maken het mogelijk om het Dastra platform te verbinden met andere externe tools;

De mogelijkheden zijn legio: koppeling met CRM-software om stakeholders automatisch op te halen, synchronisatie van een rechtenmanagementtool met de Dastra-module, etc.

Dastra is gebaseerd op de API-Rest standaard en in het bijzonder op de volgende HTTP requests:

URI GET POST PUT PATCH DELETE

URI	GET	POST	PUT	PATCH	DELETE
Bronnenverzameling, zoals `http://api.exemple.com/collection/`.	Vangt_ de URI's op van de bronnen die lid zijn van de verzamelbron in de inhoud van het antwoord.	Maakt_ een lid resource in de collection resource met behulp van de instructies in de request body. De URI van de aangemaakte lid resource wordt auto-toegewezen en geretourneerd in het Location headerveld van het antwoord.	Vervangt_ alle representaties van de lidbronnen van de verzameling door de representatie in de verzoektekst, of maakt de verzamelingbron als deze niet bestaat.	updates alle representaties van de lidbronnen van de verzamelbron met behulp van de instructies in de verzoektekst, of creëert de verzamelbron als deze niet bestaat.	Verwijdert alle representaties van bronnen die lid zijn van de verzamelbron.
Lid bron, zoals `http://api.exemple.com/collection/item3`	Haalt_ een representatie van de lidbron op in de body van het antwoord.	Creëert_ een member resource in de member resource met behulp van de instructies in de request body. De URI van de aangemaakte member resource wordt auto-toegewezen en geretourneerd in het Location headerveld van het antwoord.	Vervangt_ alle representaties van de lidbron, of maakt de lidbron als deze niet bestaat, met de representatie in de verzoektekst.	Werkt_ alle representaties van de lidbron bij, of maakt de lidbron aan als deze niet bestaat, met behulp van de instructies in de verzoektekst.	Verwijdert alle representaties van de lidbron.

Bronnenverzameling, zoals http://api.exemple.com/collection/.

Vangt_ de URI's op van de bronnen die lid zijn van de verzamelbron in de inhoud van het antwoord.

Maakt_ een lid resource in de collection resource met behulp van de instructies in de request body. De URI van de aangemaakte lid resource wordt auto-toegewezen en geretourneerd in het Location headerveld van het antwoord.

Vervangt_ alle representaties van de lidbronnen van de verzameling door de representatie in de verzoektekst, of maakt de verzamelingbron als deze niet bestaat.

updates alle representaties van de lidbronnen van de verzamelbron met behulp van de instructies in de verzoektekst, of creëert de verzamelbron als deze niet bestaat.

Verwijdert alle representaties van bronnen die lid zijn van de verzamelbron.

Lid bron, zoals http://api.exemple.com/collection/item3

Haalt_ een representatie van de lidbron op in de body van het antwoord.

Creëert_ een member resource in de member resource met behulp van de instructies in de request body. De URI van de aangemaakte member resource wordt auto-toegewezen en geretourneerd in het Location headerveld van het antwoord.

Vervangt_ alle representaties van de lidbron, of maakt de lidbron als deze niet bestaat, met de representatie in de verzoektekst.

Werkt_ alle representaties van de lidbron bij, of maakt de lidbron aan als deze niet bestaat, met behulp van de instructies in de verzoektekst.

Verwijdert alle representaties van de lidbron.

Bron : wikipedia;

Verschillende API's kunnen worden geconfigureerd met Dastra. De lijst met API's is hier beschikbaar: https://api.dastra.eu/swagger/index.html

Beperkingen

Een http-verzoeklimiet is ingesteld op 500/min of 10000/10min.

Beveiligingsopties (met name IP-filtering) zijn niet van toepassing op API's

Blootstelling van aangepaste velden in de Dastra API

In Dastra is het mogelijk om in de API aangepaste velden te tonen die ontworpen zijn vanuit je Dastra-workspace.

Aangepaste velden zijn specifiek voor elke werkruimte. Om ze mee te nemen in de Dastra API, moet je eerst de naam van hun variabele definiëren in de aangepaste velddefinitie:

https://github.com/Dastrateam/dastra-doc-nl/blob/main/features/generalites/champs-personnalises.md

De meeste entiteiten die via de API gewijzigd kunnen worden, hebben een veld met de naam "customFields" dat je kunt wijzigen

Als je velden definieert met de volgende variabele namen binnen je werkruimte:

my_field_string: een "Tekst" veld
my_field_booleen: een "aankruisvakje" veld
my_field_numeric : een "Nummer" veld
my_field_checkbox: een "Checkbox" veld

Het is mogelijk om deze informatie als volgt aan te passen

{ 
  "label": "Google Analytics 4",
  ...
  "customFields": {
     "mon_champ_string": "Waarde van mijn veld",
     "mon_champ_booleen": true,
     "mon_champ_numeric": 1,
     "mon_champ_checkbox"!:["Appel", "Banaan"],
     ...a
  }
}

API-configuratie

API's configureren in Dastra

Beperkingen

Blootstelling van aangepaste velden in de Dastra API

Tags

API's configureren in Dastra

Beperkingen

Blootstelling van aangepaste velden in de Dastra API

Tags