Skip to main content

API Builder

Overview​

API Builder is an accelerator for developing custom applications on top of Microsoft Dataverse. It eliminates the tedious code required when building APIs on top of Dataverse by providing an API generator that consumes configuration files and produces REST APIs suitable for building rich UI applications.

Traditional development of web and mobile applications on Dataverse requires significant backend development effort. API Builder shifts this responsibility from backend developers to functional consultants - the people who understand the Dataverse implementation best - enabling them to generate APIs without writing code.

The Problem: Traditional API Development​

A typical solution involving web or mobile applications built on top of Dataverse requires developing REST APIs by backend developers. This approach presents significant challenges:

Traditional Development State
Functional Consultant
·Understands Dynamics 365
·Configures entities
·Knows business rules
Knowledge
Transfer
(informal)
Backend Developer
·Writes C# code
·Creates APIs
·Maintains endpoints
·Handles changes
Custom Code
REST API
·Hand-coded
·Hard to maintain
·Sync issues with data model
Web / Mobile Applications

Challenges with Traditional Approach:

ChallengeDescriptionImpact
Knowledge TransferBackend developers must understand Dataverse customizationsScheduling constraints, incomplete understanding
ComplexityDataverse customizations are complex and evolvingSteep learning curve for developers
Documentation GapsKnowledge transfer is often informalMisunderstandings, incorrect implementations
Continuous ChangesDynamics customizations change frequentlyAPIs fall out of sync with the data model
Maintenance BurdenEvery change requires code updatesLonger implementation times, project delays
Bug IntroductionHand-coded APIs are error-proneMore application bugs, quality issues

The Solution: API Builder​

The functional consultant is better suited to develop the API than the backend developer, given their intimate understanding of the Dataverse implementation. However, functional consultants shouldn't need to write code. API Builder addresses this by shifting responsibility from backend developers to functional consultants through a no-code API generation approach.

New Development State - with API Builder
Functional Consultant
·Understands Dynamics 365
·Understands UI needs
·No backend developer required
Uses
API Builder Studio
·No-code visual designer
·Configure endpoints, schemas, security
Generates
API Metadata
·Endpoint definitions
·Schemas
·Security rules
API Builder Runtime
·Dynamic REST generation
·On-the-fly API creation
REST API
Web / Mobile Applications
·UI Developer uses API introspection
·Retrieves schema automatically
·Builds rich applications

Key Benefits​

BenefitDescription
80% Faster DevelopmentEliminates custom/boilerplate code needed to create APIs
No Backend Developer RequiredFunctional consultants generate APIs directly
Always in SyncAPI configuration lives with the Dataverse customization
Reduced BugsGenerated code is consistent and tested
Immediate ChangesUpdate API configuration, changes apply instantly
Self-DocumentingAPI introspection provides schema for UI developers

API Studio Builder​

Explore the operations hands-on. Select any operation type below to watch a functional consultant configure an endpoint in real time - inputs, entity bindings, access control, and the resulting HTTP request/response.

API Builder Studio
Module: Sales · Entity: Account
Definition
Endpointaccounts
TitleCreate Account
DescCreates a new Account record in Dynamics 365
Inputs
nameStringrequired
emailStringrequired
phoneString
creditLimitMoney
Entity Properties
name→@name
emailaddress1→@email
telephone1→@phone
creditlimit→@creditLimit
Access Control
✓ Auth RequiredStandardUser
POST/api/sales/accounts● Ready
Request
POST /api/sales/accounts
Authorization: Bearer ••••••

{
  "name": "Contoso Ltd",
  "email": "info@contoso.com",
  "phone": "+1-555-0100",
  "creditLimit": 50000.00
}
Response · 200 OK
{
  "id": "a1b2c3d4-e5f6-7890"
}

Next Steps​