You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: adaptors/openspp.md
+23-10Lines changed: 23 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,39 @@ title: OpenSSP Adaptor
4
4
5
5
## About OpenSSP
6
6
7
-
[OpenSPP (Open Smart Patient Platform)](https://openspp.org/) is an open-source platform designed to support patient-centric workflows in healthcare delivery. It enables healthcare providers to manage patient data, schedule appointments, track health outcomes, and improve service delivery through real-time data insights and integration capabilities.
7
+
[OpenSPP (Open Source Social Protection Platform)](https://openspp.org/) is an
8
+
integrated and digital social protection information system that enables
9
+
governments and humanitarian agencies to streamline the creation and management
10
+
of assistance programs.
8
11
9
12
## Integration Options
10
13
11
14
OpenSPP supports 2 primary integration options with OpenFn:
12
15
13
-
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](/adaptors/packages/openspp-docs) for more on how to use this adaptor to work with the API.
16
+
1.**Rest API:** OpenSPP has a REST API that enables external services like
17
+
OpenFn to pull data from OpenSPP, or push data from external apps to OpenSPP.
18
+
This option is suited for scheduled, bulk syncs or workflows that must update
19
+
data in OpenSPP with external information. See
20
+
[functions](/adaptors/packages/openspp-docs) for more on how to use this
21
+
adaptor to work with the API.
14
22
15
-
2.**Webhook:** Webhook or Data Forwarding to push data from OpenSPP to external systems (see [docs](https://openspp.org/api)). This option is suited for real-time, event-based data integration.
23
+
2.**Webhook:** Webhook or Data Forwarding to push data from OpenSPP to external
24
+
systems (see [docs](https://openspp.org/api)). This option is suited for
25
+
real-time, event-based data integration.
16
26
17
27
## Authentication
18
28
19
-
1. See [OpenSPP docs](https://openspp.org/security) for the latest on supported authentication methods.
20
-
2. When integrating with OpenSPP via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openspp-configuration-schema) for more on the required authentication parameters.
29
+
1. See [OpenSPP docs](https://openspp.org/security) for the latest on supported
30
+
authentication methods.
31
+
2. When integrating with OpenSPP via OpenFn, there is one primary authentication
32
+
method that is supported: **Basic Authentication**. See this adaptor's
33
+
[Configuration docs](/adaptors/packages/openspp-configuration-schema) for
34
+
more on the required authentication parameters.
21
35
22
-
See platform docs on [managing credentials](/documentation/manage-projects/manage-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:
36
+
See platform docs on
37
+
[managing credentials](/documentation/manage-projects/manage-credentials) for
38
+
how to configure a credential in OpenFn. If working locally or if using a Raw
39
+
JSON credential type, then your configuration will look something like this:
23
40
24
41
```
25
42
{
@@ -39,7 +56,3 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag
0 commit comments