Your Knowledge Base has moved to the new Help Center.  Check out the release notes for details. And don't forget to update your bookmarks and in-house documentation before May 28.

API Procedures

 

Basics

  • MinistryPlatform contains the ability to call and test API Procedures using the REST API. What procedures can be accessed by what Users are controlled by Security Roles. API documentation is available upon request by contacting Support.
  • The Administrator's Security Role has all API Procedures included. We recommend that you do not edit or remove API Procedures from the Administrator's Security Role.

Adding API Procedures to a Security Role

  1. Go to Administration > Security Roles.
  2. Open an existing Security Role (or create a new security role, name it and save it).
  3. Click on the API Procedures sub-page to assign the appropriate security rights.
  4. Click Add. A pop-up window is displayed containing all API Procedures.
  5. Check any appropriate boxes to allow the Security Role to access these tools and click Save.

Removing API Procedures from a Security Role

  1. Go to Administration > Security Roles.
  2. Open the desired Security Role.
  3. Make sure you have no selections.
  4. On the API Procedures sub-page, select the procedures you want to remove.
  5. Change the selection to Current/Unsaved Selection.
  6. Click the Delete button and confirm deletion.