Skip to content
English
  • There are no suggestions because the search field is empty.

Can MerchantSpring API documentation be shared with clients?

Learn whether MerchantSpring API documentation can be shared with external clients or partners.

MerchantSpring API documentation may be shared with external developers or partners depending on the nature of the integration and the permissions granted to your organization.

Because API documentation contains technical information about platform endpoints and authentication processes, access is typically provided to developers who are building approved integrations with the MerchantSpring platform.


When API Documentation May Be Shared

Organizations may share API documentation with trusted partners or clients when they are:

  • developing custom reporting integrations
  • building internal analytics dashboards
  • integrating MerchantSpring data with external systems
  • creating automated reporting workflows

In these cases, developers may require direct access to API documentation.


Security Considerations

API documentation often includes information about:

  • authentication methods
  • endpoint structures
  • request and response formats

For security reasons, organizations should ensure that documentation is only shared with trusted developers or technical partners.


Best Practices for Sharing API Information

When sharing API documentation:

  • limit access to authorized developers
  • avoid sharing authentication credentials
  • follow internal data security policies

This helps protect both platform security and sensitive business data.


Notes: 

  • API access may require approval from MerchantSpring.
  • Sharing documentation does not automatically grant API credentials.
  • Integration partners should follow all usage guidelines.
For questions about API access or documentation sharing, contact support@merchantspring.com.au.