npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ministry-platform-api-wrapper

v1.1.2

Published

JavaScript API Wrapper for interacting with the Ministry Platform API

Downloads

20

Readme

MinistryPlatformAPI Node Package

A robust and handy API Client for MinistryPlatformAPI.

Installation

To use this package in your project:

npm i ministry-platform-api-wrapper

Setup

Before utilizing the API client, it's essential to set up the required environment variables in a .env file. These variables act as configuration parameters for your API client, ensuring proper and secure functioning.

Environment Variables:

Create a .env file in your root directory and define the following variables:

OAuthClientID=yourClientID
OAuthClientSecret=yourClientSecret
OAuthBaseAddress=yourOAuthBaseAddress
ServiceAddress=yourServiceAddress

Descriptions:

  • OAuthClientID: Your API Client's ID. More information about API Clients can be found here.
  • OAuthClientSecret: Your API Client's Secret. Keep this confidential.
  • OAuthBaseAddress: Your OAuth discovery URL. More about your discovery URL here.
  • ServiceAddress: Your platform API URL. More on your platform API URL here.

Make sure you've also installed the dotenv package:

npm install dotenv --save

Then, at the beginning of your main app file (e.g., app.js), insert:

require('dotenv').config();

Usage

Here are some examples to get you started:

Creating a Web API Client

const MinistryPlatformAPI = require('ministry-platform-api-wrapper');

await MinistryPlatformAPI.CreateWebApiClient();
console.log("Web API Client created successfully");

Getting Domain Data

const domain = await MinistryPlatformAPI.request('get', '/domain', null, null);
console.log(domain);

Retrieving a User

const user = await MinistryPlatformAPI.request('get', '/tables/dp_Users/1', {$select: "Display_Name"}, null);
console.log(user);

Fetching Groups

const groups = await MinistryPlatformAPI.request('post', '/procs/api_MPP_GetMyGroups', null, {"@ContactID": 1});
console.log(groups);

Updating Contact Information

const contact = await MinistryPlatformAPI.request('put', '/tables/Contacts', null, [{"Contact_ID": 1, "Nickname": "Jon"}]);
console.log(contact);

Documentation & Further Information

Dive deeper into the API and its functionalities by visiting the comprehensive documentation provided by MinistryPlatformAPI:

[API Documentation](https://{your platform domain}/ministryplatformapi/swagger/ui/index)

Replace {your platform domain} with your actual platform domain.

Feedback

If you have any issues or feedback on improving this package, please raise an issue or contribute to the repository.