You can use this page to find the API reference for developers building with MDriven Framework and to choose the right MDriven integration interface for your application.

MDriven Framework API reference

The MDriven Framework API reference is available at MDriven Framework API documentation. Use the reference when you need API-level details while developing an application with MDriven Framework.

For example, if you are writing a Framework-based application that accesses data through the persistence layer, start with the API reference and then review the relevant server communication documentation.

Choose the API documentation that matches your task

MDriven uses several interfaces for different integration and application-development scenarios. Choose the documentation based on what you want to do.

Your goal	Start here	Example
Build with the MDriven Framework API	MDriven Framework API documentation	You need type and member details while writing Framework application code.
Connect a Framework client to a remote persistence layer over Web API	Documentation:WebApi	You are replacing a PersistenceMapperWCFClient with PersistenceMapperWEBAPIClient.
Access data or use MDrivenServer interfaces	Documentation:MDriven Server User/Web interface	You need to understand the persistence API or the JSON-based alternatives offered by MDrivenServer.
Expose or consume REST services	Documentation:Rest API	Your application calls an external REST endpoint, or you want to expose a service from MDriven Turnkey.
Work with the Turnkey web client's Streaming Client API implementation	Documentation:AngularJS Client	You need context for the AngularJS client included with the standard Turnkey web client.
Download a versioned MDriven product release programmatically	Documentation:REST API For MDriven Versioned Downloads	You need a GET request for a selected product, platform, and build-date version.

How to use the reference

1. Open the MDriven Framework API documentation.
2. Identify the MDriven component or type used by your application code.
3. Use the reference to inspect the available members and their types.
4. If the code communicates with a remote persistence layer, follow Documentation:WebApi for the Web API client and server setup.
5. If your requirement is system-to-system HTTP integration rather than Framework application code, use Documentation:Rest API instead.

Keep API scopes separate

Do not treat all HTTP-facing MDriven functionality as the same API.

• The MDriven Framework API reference is for Framework development.
• Web API describes communication between an MDriven application and its remote persistence layer.
• REST API covers REST service exposure and consumption, including external-system integrations.
• Versioned-download REST API is a separate endpoint for retrieving MDriven product releases.

For example, use the versioned-download endpoint when automating retrieval of a Turnkey or MDrivenServer release. Do not use it as a data-access interface for an MDriven application.

Related integration guidance

Documentation:Integration organizes documentation for authentication, external APIs and services, data import and export, and third-party integrations. Use it when your task spans more than one integration concern, such as calling an external API with an authentication mechanism.

See also

• Documentation:WebApi
• Documentation:Rest API
• Documentation:MDriven Server User/Web interface
• Documentation:Integration
• Documentation:REST API For MDriven Versioned Downloads
• Education:TheIndex