Skip to main content

OpenSSP Adaptor

About OpenSPP​

OpenSPP (Open Source Social Protection Platform) is an integrated and digital social protection information system that enables governments and humanitarian agencies to streamline the creation and management of assistance programs.

Integration Options​

OpenSPP supports 2 primary integration options with OpenFn:

  1. Rest API: OpenSPP has a REST API that enables external services like OpenFn to pull data from OpenSPP, or push data from external apps to OpenSPP. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenSPP with external information. See functions for more on how to use this adaptor to work with the API.

  2. Webhook: Webhook or Data Forwarding to push data from OpenSPP to external systems (see docs). This option is suited for real-time, event-based data integration.

Authentication​

  1. See OpenSPP docs for the latest on supported authentication methods.
  2. When integrating with OpenSPP via OpenFn, there is one primary authentication method that is supported: Basic Authentication. See this adaptor's Configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "password": "@some(!)Str0ngp4ss0w0rd",
  "username": "test@openfn.org",
  "database": "devel",
  "baseUrl": "https://dev.newlogic-demo.com"
}
  1. OpenSPP Documentation
  2. API Reference
  3. Integration Guide

Implementation Examples​

Coming soon!