SDK Documentation
Introduction
The Mendix SDK documentation is divided into the sections described below.
- For how-to details on Mendix Platform SDK versions below 5.0, see Old SDK Versions (Below 5.0).
- For details on the releases of the Mendix SDKs, check the Mendix Platform SDK Release Notes and the Mendix Model SDK Release Notes.
SDK Introduction
The Mendix SDKs consist of Mendix Platform SDK and Mendix Model SDK. Before diving right into the details of SDKs, you can start with the SDK Introduction.
SDK Use Cases
The Use Case Examples provide examples from the four basic categories of actions performed with the Mendix SDK: analyzing, exporting, modifying and importing.
SDK FAQ and Troubleshooting
This document provides the FAQs and troubleshooting information for common error messages.
If you need help with the SDKs, check whether your question is answered in the SDK FAQ. Otherwise, ask your question in the Mendix Community.
SDK Reference Guide
Browse the reference documentation below about the Mendix Metamodel:
- Mendix Metamodel – explains the basic components of the Mendix Metamodel as well as the domain model, microflows, pages, and apps in the Mendix Metamodel
- JavaScript & TypeScript Resources – summarizes TypeScript and provides links to useful resources for learning more
SDK How-tos
Follow these step-by-step guides to learn everything you need about using the SDK:
- Set Up Your Development Environment – leads you through the process of setting up everything you need to start working with the Mendix Platform SDK
- Set Up Your Personal Access Token – guides you in the process of creating and saving your personal access token, which is required to authenticate your script
- Create Your First Script – teaches you how to write a script that will use the Mendix Platform SDK
- Use Mendix Platform SDK – guides you on how to use the Platform SDK to create, open, and delete Mendix apps as well as how to make changes to your app
- Create the Domain Model – guides you in the process of creating a more extensive domain model
- Manipulate Existing Models – teaches you how to change things in the model, close the server connection, and find and load units and elements
- Generate Code from the Model – explains how to write code to alter your model