Het configureren, registreren en gebruiken van Custom API's binnen Dataverse.
Custom API's maken het mogelijk om server-side functionaliteit beschikbaar te stellen als een expliciet aanroepbaar endpoint binnen Dataverse.
Ze worden gebruikt voor:
Voor richtlijnen over architectuur, services en ontwikkeling:
đ Zie Plugin & Custom API Development.
Gebruik een Custom API wanneer functionaliteit expliciet moet kunnen worden aangeroepen door:
Een Custom API is geschikt voor herbruikbare functionaliteit die onafhankelijk van events moet kunnen worden uitgevoerd.
Custom API's worden als component toegevoegd aan een Solution.
Belangrijke instellingen zijn:
Gebruik consistente naamgeving volgens de geldende Naming Conventions.
Voorbeelden:
unica_validateAddress
unica_calculateContractValue
unica_generateProjectNumber
Custom API's kunnen op twee manieren worden ingericht.
Een Bound API is gekoppeld aan een specifieke tabel.
Voorbeelden:
De API wordt uitgevoerd in de context van een record.
Een Unbound API staat los van een specifieke tabel.
Voorbeelden:
De API kan vanuit iedere context worden aangeroepen.
Gebruik:
Request Parameters bepalen welke informatie aan de Custom API wordt meegegeven.
Veelgebruikte types zijn:
Voorbeelden:
ContractId
CustomerNumber
CountryCode
Response Properties bepalen welke gegevens worden teruggegeven aan de aanroeper.
Voorbeelden:
Een Custom API wordt technisch gekoppeld aan een Plugin.
De Plugin:
Plaats business logica altijd in services.
Een Custom API moet uitsluitend verantwoordelijk zijn voor:
Custom API's kunnen worden aangeroepen via de Dataverse Web API.
Veelgebruikte scenario's:
const request = {
customerNumber: "10001",
getMetadata: function () {
return {
boundParameter: null,
operationType: 0,
operationName: "unica_validateCustomer",
parameterTypes: {
customerNumber: {
typeName: "Edm.String",
structuralProperty: 1
}
}
};
}
};
const response = await Xrm.WebApi.execute(request);
if (response.ok) {
const result = await response.json();
}
Custom API's kunnen worden uitgevoerd vanuit Power Automate.
Veelgebruikte scenario's:
Custom API's maken onderdeel uit van de Dataverse beveiliging.
Alle bedrijfskritische validaties moeten binnen de server-side implementatie worden gecontroleerd.
Voorbeelden:
Voorbeelden:
Voorbeelden:
Ontwikkel API's met ÊÊn duidelijke verantwoordelijkheid.
Plaats business logica nooit rechtstreeks in de Custom API implementatie.
Pas dezelfde naamgevingsstandaarden toe als voor Plugins, Flows en JavaScript.
Voorkom onnodige wijzigingen aan bestaande Request Parameters of Response Properties.
Leg vast:
â Te veel parameters
â Business logica in de API implementatie
â Onvoldoende foutafhandeling
â Onduidelijke naamgeving
â Geen documentatie van input en output
â Onnodig complexe API's
Custom API's maken onderdeel uit van de Business Logic laag.
Ze worden gebruikt als:
Custom API's vormen de brug tussen:
| Onderwerp | Relatie |
|---|---|
| Plugin & Custom API Development | Ontwikkelrichtlijnen voor server-side logica |
| Plugin Usage | Event-driven alternatief |
| JavaScript | Veelgebruikte consument van Custom API's |
| Cloud Flows | Kunnen Custom API's aanroepen |
| Logic Implementation Guidelines | Ondersteunt de keuze van de juiste techniek |
| Integration Patterns | Custom API's worden vaak gebruikt binnen integraties |
Custom API's bieden een gestandaardiseerde manier om server-side functionaliteit beschikbaar te maken binnen Dataverse.
Ze zijn geschikt voor:
Door gebruik te maken van duidelijke Request Parameters, consistente Response Properties en een service-based architectuur ontstaan oplossingen die:
zijn binnen het Power Platform.