Table of contents

    The new API platform in MYP enables users to pull data from the relevant fields in MYP into any other software that they wish to connect to the MYP APIs (subject to that software having the capability to interface with APIs). This creates a very flexible environment for other types of software to access the MYP data in a very efficient way.

    The MYP API uses REST architecture. It accepts form-encoded requests, returns responses in JSON format and uses standard HTTP response codes.

    To develop with the MYP API, applications need to be authenticated. For information on how to do so, refer to the Authentication article.

    Once an application is authenticated, API calls to MYP can be made. For instructions on how to call the MYP API, refer to the Call endpoint article.

    To understand the different MYP API endpoints, use the side navigation to select an endpoint (e.g. Client) within a particular module (e.g. ARM).

    Response codes

    MYP API response codes are documented in the Call endpoint article.

    Usage limits

    MYP API usage limits, such as how many calls are allowed per IP address, are outlined in the Limitations article.


    Return home Next article