Standaard-web-API

Belangrijk

Deze inhoud is gearchiveerd en wordt niet bijgewerkt. Raadpleeg de pagina Microsoft Dynamics 365-productdocumentatie voor de meest recente documentatie. Raadpleeg de pagina Releaseplannen voor Dynamics 365 en Microsoft Power Platform voor de meest recente releaseplannen.

Notitie

Deze releaseopmerkingen bevatten beschrijvingen van functionaliteit die mogelijk nog niet is uitgebracht. Als u wilt weten voor wanneer de vrijgave van deze functionaliteit staat gepland, raadpleegt u Nieuwe en geplande functies voor Dynamics 365 Business Central Leveringstijdlijnen kunnen wijzigen en verwachte functionaliteit kan veranderen of helemaal niet beschikbaar komen (zie Microsoft-beleid).

De standaard-web-API heeft de bèta-fase doorlopen. De API bevond zich in bèta terwijl hij verder werd ontwikkeld op basis van feedback van de partnercommunity. In deze versie worden de laatste verbeteringen en verschillende nieuwe entiteiten in de API samen uitgebracht als versie 1.0.

Verbeteringen voor ontwikkelaars

• API's ontwikkelen in AL met aangepaste naamruimten
• Open API-specificatie 3.x

Wijzigingen van bèta naar API's van v1.0

• Diepe nesting van entiteit
• Eenvoudige sleutels
• API voor registratie van werknemerurenstaten

Zakelijke waarde

De standaard-web-API biedt meer dan 48 entiteiten, waardoor losse integraties met Business Central mogelijk zijn. Als u de web-API gebruikt, hoeft u geen ontwikkeling of implementatie uit te voeren in Business Central. De belangrijkste ontwerpdoelstellingen waren om API's aan te bieden die geen diepgaande kennis van Business Central vereisen, en om een contract met een vaste versie te bieden dat op gestandaardiseerde wijze integraties mogelijk maakt met verschillende lokalisaties en implementaties van Business Central.

De standaard-API is in Business Central online standaard ingeschakeld en kan ook voor lokale implementaties worden ingeschakeld.

API's ontwikkelen in AL

In extensies kunnen API's beschikbaar worden gesteld die gebruikmaken van het API-platform in Business Central. Dit betekent dat aangepaste API's dezelfde mogelijkheden hebben als de standaard-API's. Dit omvat ondersteuning voor webhooks, OAS 3.0, OData v4 en versiebeheer.

Bij de ontwikkeling van API's wordt gebruik gemaakt van aangepaste naamruimten, een manier om API's te segmenteren in groepen. Hiervoor moet de API de eigenschappen APIPublisher, APIGroup en APIVersion opgeven.

page 50100 ApiPageExpenses
{
    PageType = API;
    Caption = 'apiPageName';
    APIPublisher = 'contoso';
    APIGroup = 'expenses';
    APIVersion = 'v2.0';
    EntityName = 'Receipt';
    EntitySetName = 'Receipts';
    SourceTable = ContosoReceipt;
    InsertAllowed = true;
    DeleteAllowed = true;
    layout
    {
        area(Content)

Tijdens de uitrol zorgt het bovenstaande voorbeeld ervoor dat routeringstabellen worden bijgewerkt, waarmee het eindpunt beschikbaar wordt gesteld in de opgegeven naamruimte.

GET https://api.businesscentral.dynamics.com/v1.0/api/contoso/expenses/v2.0/companies(7d0b2f2d-150e-4596-b064-e66f3491811c)/Receipts

Open API-specificatie 3.x

Business Central biedt ondersteuning voor het genereren van OAS 3.0. OAS biedt een algemene indeling voor metagegevens, waaruit SDK's kunnen worden gegenereerd voor de meeste programmeertalen.

Na april 2019 wordt API-documentatie van Business Central ook via OAS gegenereerd.

Diepere nesting van entiteiten

Vanwege beperkingen in Onderdelenpagina's is het niet mogelijk om een entiteitsstructuur te hebben die dieper gaat dan twee niveaus. Een voorbeeld is:

/journal({id})/journalLine(id)

Met die beperking voor dit specifieke voorbeeld is attachments naar journalLines omslachtig in het gebruik, omdat er geen manier is om de resource rechtstreeks aan te spreken:

/journal({id})/journalLine(id)/attachment(id)

In de huidige bèta-implementaties is attachments op het hoofdniveau geplaatst.

Eenvoudige sleutels

Complexe sleutels of sleutels met meerdere delen maken de API's moeilijker in het gebruikt, omdat het maken van verzoeken meerdere parameters kan vereisen. Vanaf april 2019 maken API's gebruik van eenvoudige sleutels.

API voor registratie van werknemerurenstaten

Urenstaten voor medewerkers worden mogelijk gemaakt via de standaard-API. Urenstaten binnen Business Central ondersteunen momenteel de tijdregistratie van medewerkers op resources. Met de huidige implementatie kan een resource meerdere machines en personen vertegenwoordigen. Vanaf april 2019 vereist het gebruik van urenregistratie van medewerkers dat de resource waarop de tijd is geregistreerd naar één medewerker verwijst.

Doelgroepen

Eindgebruikers, beheerders, aanpassers, burgerontwikkelaars, ontwikkelaars

Status

Momenteel zijn alle API's in bèta. Tegen april 2019 zullen API's van v1.0 worden gepubliceerd, die de hierboven beschreven verbeteringen bevatten.

Beschikbaarheid

SaaS, on-premises

Geef ons uw mening

Help ons Dynamics 365 Business Central te verbeteren door ideeën te bespreken, suggesties te doen en feedback te geven. Gebruik het forum voor Business Central op https://aka.ms/businesscentralideas.