App - Development: Rest Interface
This REST API documentation is your starting point for accessing the matterial app.
The matterial API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON and XML request bodies (payload), returns JSON, XML or plain text responses, and uses standard HTTP response codes.
Before you start using the API you should be familiar with the matterial application and the concepts behind it. It is especially important to understand how matterial treats documents, versions and languages.
Quick Start Guide
Sample Ruby client
C# Client Library
A full C# client library wrapping the REST API is documented here:
Matterial Core C# Client Library
SaaS vs. on premise
Matterial is a cloud-based software but it can also be installed on premises. Some of the API features are only available with the SystemAccount permission. This permission is only available for on premise installations.
Breaking changes and additions are documented within the API Changes.
The authentication requests are used to logon to matterial using different methods, like user and password authentication, Google OAuth or different other methods.
Logon - Ntlm
Logon - OAuth2 - Google
Logon - OAuth2 - Cobot
Logon - OAuth2 - Microsoft
Logon - LTI
Logon - Saml
Logon - AutoLogin
Logon - MagicLink
The document interface is probably the most comprehensive interface of matterial. It includes all functionalities around documents. Before you use it, you should be familiar with the way matterial manages documents. You will find all the necessary information here: Working with documents
Document - Search
Document - AdditionalProperty
Document - Rating
Document - SavedSearch
Document - ChangeLog
Document - Lock
Document - ExtensionValue
The Temp File API is used to handle upload of files to matterial.
Matterial supports categorising documents in a very powerful way. This API lets you manage, create update and follow categories.
Category - CategoryType
You can add Comments to documents and this API lets you manage them.
The person API allows you to manage user accounts, profile settings and export of user data.
Person - Search
Person - AccountSetting
Permissions are a core feature of matterial. It is based on roles.
Matterial includes workflow-type features and the Task API lets you handle that part of the application.
Client (On-Premise Only)
If matterial is installed on premise, it is multi-client capable which means you can create and manage multiple clients. A Client represents a separate set of data like documents persons, etc. within the same material instance. A person can switch easily between clients without having to change the instance.
Client - CompanyInfo
Client - Logo
Client - ClientPreference
The Instance Management interface allows you to configure instance settings and manage/create instances.
Most of the requests require the SystemAccount permission which is only available for on premises installations.
InstanceControl - MtrMessage
InstanceControl - Preference
Add and manage languages.
Possibility to overwrite styles.
The matterial server is able to convert back and forth between Html and Markdown format. You can use the API to convert matterial documents.
Handle notification settings and configure how users should be notified.
The Tracking API allows you to access statistic data of the matterial instance.
Get version information about the matterial server.
Get the changelog of the application.
The famous “Hello world” test.
A list of the constants of entity types.
Matterial status codes.