Data API Overview

The Micello Data API provides the ability to access files as well as the surrounding metadata and information pertaining to the files and the system. 

API URL Construction

Each Data API has several distinct parts to make up the URL used for the REST call which include:

  • Base URL
  • Endpoint (which includes the API Current Version)
  • Resource
  • Path Arg (not always applicable) 
  • Parameters

All API service calls use the same Base URL and Endpoint:

<base_url>/ms/<api_version> (i.e. mfs.micello.com/ms/v1)

The current version is “v1”. When an upgrade occurs, this is the portion that would change (i.e. v1.1, v2, etc).

The Resource, any necessary Path Args and Parameters are specific to the unique API calls. Each API call has a definition page which provides more information.

Path & File Versions

The Micello Data API has a unique and a powerful way of handling files and their respective paths. Read about it here.

Keys & Security

Access to the Micello Data APIs requires a valid key as well as the appropriate permissions.

Service Calls
The following are the currently available calls:

File, Path & Key Information

File Retrieve

Path Retrieve

Path Variable Retrieve

Pattern Retrieve

Key Retrieve

Data Packages

Package Retrieve

Package Assembly Initiation

Package Assembly Pickup

Management

File Create

Batch File Create

Path Alter

Pattern Manage

Package Manage

Key Manage

Authentication String Manage

Distribution

Distribution File Listing

Distribution Key Listing

Distribution Package Listing