API Web standard

  • Article

Important

Ce contenu est archivé et n’est pas mis à jour. Pour accéder aux dernières ressources documentaires, voir documentation des produits Microsoft Dynamics 365. Pour accéder aux derniers plans de lancement, voir Plans de lancement Dynamics 365 et Microsoft Power Platform.

Notes

Ces notes de publication décrivent des fonctionnalités qui n'ont peut-être pas encore été publiées. Pour connaître la période de lancement prévue pour cette fonctionnalité, consultez Nouveautés et prévisions pour Dynamics 365 Business Central. Les délais de livraison peuvent changer et la fonctionnalité prévue peut ne pas être lancée (voir Stratégie de Microsoft).

L'API Web standard sort de la version bêta. L'API était en version bêta mais évolue afin de répondre aux commentaires de la communauté des partenaires. Cette version intègre les dernières améliorations et plusieurs nouvelles entités de l'API en version 1.0.

Améliorations apportées aux développeurs

  • Développement des API dans AL à l'aide d'espaces de noms personnalisés
  • Open API Specification (OAS) 3.x

Passage de la version bêta aux API v1.0

  • Nidification d'entités profonde
  • Clés simples
  • API d'enregistrement de feuille de temps employé

Valeur commerciale

L'API Web standard expose plus de 48 entités, permettant des intégrations faiblement couplées à Business Central. Si vous utilisez l'API Web, vous n'avez pas besoin de développement ni de déploiement dans Business Central. Les objectifs clés de la conception consistaient à fournir des API ne nécessitant pas de connaissance approfondie de Business Central et à fournir un contrat à version fixe, ce qui permet une méthode standardisée d'intégration entre les localisations et les déploiements de Business Central.

L'API standard est activée par défaut dans Business Central en ligne et peut également être activée pour les déploiements sur site.

Développement d'API dans AL

Les extensions peuvent exposer des API, qui tirent parti de la plateforme API de Business Central. Cela signifie que les API personnalisées ont les mêmes fonctionnalités que les API standard. Cela inclut la prise en charge de Webhooks, d'OAS 3.0, d'OData v4 et de la gestion des versions.

Développement des API à l'aide des espaces de noms personnalisés : un moyen de segmenter les API en groupes. Cela nécessite que l'API spécifie les propriétés APIPublisher, APIGroup et APIVersion.

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)

Au moment du déploiement, l'exemple ci-dessus provoque la mise à jour des tables de routage, ce qui expose le nœud final dans l'espace de noms spécifié.

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

Open API Specification (OAS) 3.x

Business Central fournira une assistance pour générer OAS 3.0. OAS fournit un format de métadonnées commun à partir duquel les SDK peuvent être générés pour la plupart des langages de programmation.

Après avril 2019, la documentation de l'API de Business Central sera également générée via OAS.

Nidification d'entités plus profondes

En raison des limitations dans les pages de composants, il est impossible d'avoir une structure d'entité plus profonde que deux niveaux. Par exemple :

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

Avec cette limitation, pour cet exemple spécifique, le fait de placer pièces jointes dans journalLines est difficile à utiliser, car il n'existe aucun moyen de s'adresser directement à la ressource :

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

Les mises en œuvre en version bêta actuelles ont pièces jointes dans la racine.

Clés simples

Les clés à plusieurs parties/complexes rendent l'utilisation des API plus difficile, car la construction de requêtes peut nécessiter plusieurs paramètres. D'ici avril 2019, les API utiliseront des clés simples.

API d'enregistrement de feuille de temps employé

Les feuilles de temps des employés seront activées via l'API standard. Les feuilles de temps dans Business Central prennent actuellement en charge l'enregistrement des heures des employés sur les ressources. Avec la mise en œuvre actuelle, une ressource peut représenter plusieurs machines et personnes. D'ici avril 2019, pour utiliser l'enregistrement de la feuille de temps des employés, il faudra que la ressource sur laquelle l'heure est enregistrée pointe vers un employé.

Personnages

Utilisateurs finaux, administrateurs, personnalisateurs, développeurs citoyens, développeurs

Statut

Actuellement, toutes les API sont en version bêta. D'ici avril 2019, des API seront publiées en v1.0, et bénéficieront des améliorations décrites ci-dessus.

Disponibilité

SaaS, local

Donnez-nous votre avis

Aidez-nous à améliorer Dynamics 365 Business Central en proposant des idées, en fournissant des suggestions et en faisant des commentaires. Utilisez le forum de Business Central à l'adresse https://aka.ms/businesscentralideas.