Getting started

Welcome to the MPS API Platform! This platform enables developers to explore, subscribe to, and integrate with our APIs. Follow this guide to get started on building applications with our APIs.

1. Sign up and Sign In

To access and use our APIs, you’ll need to go to the Sign in button at the top-right of the portal:

  • Sign up: Create an account by clicking on the Sign up button.

  • Sign In: After signing up, sign in to access additional features such as viewing restricted APIs, requesting subscriptions, and generating API keys.

2. Subscribe to APIs

To begin calling APIs, you need an active subscription. Subscriptions are associated with specific APIs or API plans and determine your access level, request limits, and throttling policies.

  1. Browse Subscription Plans: Each API may have one or more subscription plans. Review the available plans and choose one that aligns with your intended usage.

  2. Request a Subscription: Once you select a plan, click on Subscribe to request access. Some subscriptions may require admin approval, and you’ll receive an email notification upon approval.

  3. Generate API Keys: For approved subscriptions, you can generate an API key that allows access to the API. Navigate to Subscriptions under your profile to view or regenerate your API key as needed.

Note: Keep your API keys secure. They grant access to your subscriptions and should not be shared publicly or in unsecured environments.

3. Authenticate your API Calls

Our APIs require authentication to ensure secure access:

  • Subscription Key Authentication: Use the provided API key for most requests. Set your Subscription key in the Authorization header with each API call.

  • OAuth2: We require OAuth2 authorization as well, use the discovery document to see how to obtain an access token.

Note: Currently, both of the above headers need to be present as shown in the documentation per API.

The inbound delivery API uses OAuth's client-credential flow which requires you to obtain an access token using a client ID and secret. Contact us for more information.

Growers can manage their own permissions in their registration environment at MPS. If your software is allowed to connect, using the credentials, we check if the grower has given you explicit permission to update their data as well.

4. Trace your API Calls

When you submit a correctly formatted request, the API returns an HTTP 202 Accepted response, indicating that your request has been successfully received. You will also receive a unique Request-ID, which you can use to track the request.

The request status and logs can be retrieved via the Trace API by using the Request-ID as the trace-id query parameter for both the /log and /processing-status endpoints. The Trace API is available for all subscriptions.

NOTE: As of 30-may-2026 the Trace API only returns high level information. More detailed processing logs and statusses are still in development.