Category:MFGX.IO

From MFGx.io Documentation
Jump to: navigation, search

MFGx.io is a web based solution hosted in Amazon Web Services that serves as the hub for all functionality shared between our applications.

Terminology

A few common terms you may run across while interacting with MFGx.io:

  • API: (Application Programming Interface) A software interface that allows access to create, read, update, or delete entities. Ex. Parts, Orders
  • API Base: The lowest level of API grouping, defining the general category of the API. There are currently three API bases:
    • auth: APIs under the auth base perform functions related to authentication, environments, and passwords.
    • meta: APIs under the meta base modify the MFGx.io configuration, such as users, roles, or environments. This data is stored internally in MFGx.io, rather than being passed to endpoints.
    • rest: APIs under the rest base modify business objects, such as parts or orders. These APIs can be mapped into environments.
  • API Group: The middle level of API grouping, defining the "module" of an API. Ex. Access Control, Engineering
  • API Version: A specific version of an API that defines a standardized format for entities returned. Ex. Parts v1, Orders v2
  • Endpoint: A single destination that allows access to one or more APIs. Ex. Plex Test, Plex Production
  • Endpoint Credential: A set of credentials providing access to an endpoint. Could be a username and password, an API key, etc.
  • Entity: A single business object, provided by an API from one or more endpoints. If more than one endpoint returns data that represents the same object, those objects are unified into a single entity. Ex. part 1234, order 5678
  • Environment: A logical collection of endpoint API versions, defining where data is stored and retrieved for each business API.
  • Provider: A business or software application that "provides" an endpoint for API access. Ex. Plex Systems

Demo Site

A stripped down version of the site is avilable for public demonstrations at http://demo.mfgx.io

Features

MFGx.io is able to communicate with many different systems and applications both internal and external to Cumulus. Target applications for this platform include:

  • User Management
  • Site Administration
  • Mobile Device Configuration and Control
  • B2B integrations
    • Manual Requests
    • Automation schedules

Example

MFGX IO 01.png

This category currently contains no pages or media.