Momentum AMS Public API
Momentum AMS provides a Public API that allows developers and integration partners to connect external systems to the Momentum platform.
This guide explains how to access the API documentation, select the correct testing environment, request a dedicated test agency, and validate integrations before using them with live agency data.
Begin by reviewing the Momentum Public API Documentation. When testing API requests, select the External Partner Testing environment.
1. Access the Momentum Public API Documentation
The Momentum Public API documentation is available through the Stoplight developer portal.
Open Momentum Public API Documentation
The developer portal provides information about:
- API Endpoints: Available endpoints for connecting external systems to Momentum AMS.
- Requests and Responses: Supported request and response formats.
- Authentication: Requirements for authenticating API requests.
- Examples: Sample API requests and responses.
- Parameters: Descriptions of the parameters used by each endpoint.
Use the API documentation as your primary technical reference when developing integrations. Review the authentication requirements, endpoint parameters, and example requests before beginning testing.
2. Select the Correct Testing Environment
When testing API requests through the documentation portal or an API testing tool such as Postman, select the following environment:
REQUIRED TESTING ENVIRONMENT
External Partner Testing
This environment is intended for integration development and testing.
Using the correct environment allows you to:
- Route API requests to the appropriate testing endpoints.
- Test integrations without affecting production agency data.
- Validate API requests and responses before working with live records.
Confirm that External Partner Testing is selected before submitting API requests. This helps prevent test activity from being directed to a production environment.
3. Understand the Test Agency Environment
The External Partner Testing environment is configured with a test agency provided by Momentum.
This environment is designed to closely mirror production behavior, allowing integration partners to simulate common system activities.
What You Can Do in the Test Environment
- Submit API requests using supported endpoints.
- Simulate integration activity using test agency records.
- Review data created during testing.
- Validate integration behavior before moving to production.
Data created in the External Partner Testing environment does not impact live agency records. Use this environment to develop and validate your integration before going live.
4. Request a Dedicated Test Agency
Integration partners may request a dedicated test agency rather than using the existing test agency configuration.
If your organization requires a dedicated agency for integration development and testing, contact the Momentum Partner Support Team.
How to Request a Test Agency
- Send an email to integrations@momentumamp.com.
- Indicate that your organization is requesting a dedicated test agency for Public API integration testing.
- The Momentum team will create and configure a test agency for your integration testing.
A dedicated test agency provides your organization with a separate agency configuration for developing and validating integrations.
5. Access the Test Website
Credentials for accessing the test website environment will be provided separately.
These credentials allow integration partners to log in and review the results of API activity within the test agency.
Using the Test Website
Once your credentials are available, you can:
- Log in to the test website environment.
- Review records created or updated through API requests.
- Validate that information is being processed as expected.
- Compare the results with the intended integration behavior.
After submitting an API request, review the corresponding record in the test website when applicable. This provides an additional way to verify that the request produced the expected result.
6. Quick Reference
| Resource | Information |
|---|---|
| API Documentation | api.momentumamp.com |
| Testing Environment | External Partner Testing |
| Test Agency | Provided by Momentum |
| Dedicated Test Agency | Available upon request |
| Integration Support | integrations@momentumamp.com |
| Test Website Credentials | Provided separately |
7. Need Additional Assistance?
If you need assistance with the Momentum Public API, contact the Momentum integration support team.
Common support topics include:
- API authentication requirements
- Testing environment configuration
- API request testing
- Dedicated test agency setup
- Integration development questions
Email: integrations@momentumamp.com
Start with the Momentum Public API documentation, select the External Partner Testing environment, and use the available test agency to develop and validate your integration.
If a dedicated testing agency is needed, contact the Momentum integration support team before proceeding.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article