API Reference Overview
Welcome to the official API Reference documentation for MSDN. This section provides detailed information on all available APIs, including their endpoints, parameters, return values, and usage examples.
Explore the navigation sidebar to find specific API categories and individual methods. Each API documentation page is designed to be clear, concise, and practical, helping you integrate our services efficiently.
Authentication API
POST /auth/login
Authenticates a user and returns an access token.
Parameters:
- username (string, required): The user's login name.
- password (string, required): The user's password.
Returns:
- An object containing an
accessToken
(string) andexpiresIn
(integer, seconds).
Example:
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresIn": 3600
}
POST /auth/register
Registers a new user account.
Parameters:
- email (string, required): The user's email address.
- password (string, required): The user's desired password.
- displayName (string, optional): The user's public display name.
Returns:
- A success message indicating the user has been registered.
Data Management API
GET /data/{id}
Retrieves a specific data record by its unique identifier.
Parameters:
- id (string, required): The unique identifier of the data record.
Returns:
- The requested data record object.
Exceptions:
404 Not Found
: If the record with the specified ID does not exist.
POST /data
Creates a new data record.
Parameters:
- payload (object, required): The data to be stored.
Returns:
- The newly created data record object, including its assigned ID.
Storage API
PUT /storage/upload
Uploads a file to the storage service.
Parameters:
- file (file, required): The file to upload.
- destinationPath (string, required): The path where the file should be stored.
Returns:
- An object containing the URL of the uploaded file and its metadata.
GET /storage/download/{filePath}
Downloads a file from the storage service.
Parameters:
- filePath (string, required): The path of the file to download.
Returns:
- The file content as a stream.
Web Development
APIs related to building modern web applications with Microsoft technologies.
GET /web/components/list
Lists available pre-built web components.
Desktop Applications
APIs for creating robust desktop applications.
GET /desktop/windows/create
Provides a template for creating new application windows.
Mobile Development
APIs for cross-platform mobile application development.
GET /mobile/devices/info
Retrieves information about connected mobile devices.
Helper Functions
POST /helpers/validate-email
Validates if a given string is a valid email format.
General Utilities
GET /utils/timestamp
Returns the current server timestamp.