diff --git a/README.md b/README.md index 341169868e8b..0858cac764c8 100644 --- a/README.md +++ b/README.md @@ -118,3 +118,15 @@ served using any static contents hosting service. Builds to `main` will automatically be deployed to [docs.openfn.org](https://docs.openfn.org). This branch is protected, but we welcome pull requests! + + +### To add help sections to all adaptor files: +```bash +yarn run add-help-sections +# or +node scripts/add-help-section.js +``` + +### For new adaptor files: +When creating new adaptor documentation files, make sure to run `npm run add-help-sections` to add the standard help section. + diff --git a/adaptors/asana.md b/adaptors/asana.md index a888dc4a6b19..7235511026cd 100644 --- a/adaptors/asana.md +++ b/adaptors/asana.md @@ -39,6 +39,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. The Wildlife Conservation Society (WCS) - KoboToolBox -> GoogleSheets -> Asana sync: [https://openfn.github.io/ConSoSci/asana/](https://openfn.github.io/ConSoSci/asana/) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/azure-storage.md b/adaptors/azure-storage.md index 432aa0b17823..09c021893a3e 100644 --- a/adaptors/azure-storage.md +++ b/adaptors/azure-storage.md @@ -35,6 +35,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/beyonic.md b/adaptors/beyonic.md index f9941164d3e8..bda312ab5429 100644 --- a/adaptors/beyonic.md +++ b/adaptors/beyonic.md @@ -37,6 +37,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/bigquery.md b/adaptors/bigquery.md index 7c4a05846eb7..70848d8122ea 100644 --- a/adaptors/bigquery.md +++ b/adaptors/bigquery.md @@ -45,6 +45,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/cartodb.md b/adaptors/cartodb.md new file mode 100644 index 000000000000..b2a7c08cfb66 --- /dev/null +++ b/adaptors/cartodb.md @@ -0,0 +1,42 @@ +--- +title: CartoDB (CARTO) Adaptor +--- + +## About CartoDB + +CARTO (formerly CartoDB) is a cloud-native spatial intelligence platform that enables organizations to unlock the power of location data. Built to work natively with major cloud data warehouses like Google BigQuery, Snowflake, Amazon Redshift, and Databricks, CARTO provides advanced geospatial analysis, visualization, and app development capabilities without requiring data movement or ETL processes. The platform serves data analysts, developers, and GIS professionals with tools for spatial analytics, interactive mapping, and location intelligence. + +## Integration Options + +CartoDB supports REST API integration with OpenFn: + +**REST API**: CartoDB provides a comprehensive SQL API that enables external services like OpenFn to interact with geospatial datasets. This API allows you to execute SQL queries, insert/update spatial data, and perform complex geospatial analyses programmatically. The integration is suited for scheduled data synchronization, bulk geospatial operations, and workflows that need to update CartoDB datasets with external spatial information. See [functions](/adaptors/packages/cartodb-docs) for more on how to use this adaptor to work with the CartoDB SQL API. + +## Authentication + +To connect to CartoDB, you need to provide your account credentials: + +```json +{ + "account": "your_carto_username", + "apiKey": "your_api_key_here" +} +``` + +**Required Fields:** +- `account`: Your CARTO account username (required) +- `apiKey`: Your CARTO API key for authentication (required) + +You can obtain your API key from your CARTO account dashboard under API Keys section. + + +## Helpful Links + +- [CARTO API Reference](https://api-docs.carto.com/) +- [OpenFn CartoDB Adaptor](https://docs.openfn.org/adaptors/packages/cartodb-readme) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/chatgpt.md b/adaptors/chatgpt.md index cf880686f7f8..b852940b3ab1 100644 --- a/adaptors/chatgpt.md +++ b/adaptors/chatgpt.md @@ -45,3 +45,9 @@ technical docs on the authentication parameters required. - About ChatGPT: https://chatgpt.com/ - API docs: https://platform.openai.com/docs/overview - API Intro: https://www.chatbase.co/blog/chatgpt-api + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/cht.md b/adaptors/cht.md index bcc5f467cfa5..2fe699b0b00f 100644 --- a/adaptors/cht.md +++ b/adaptors/cht.md @@ -99,3 +99,9 @@ this: - API Docs: https://docs.communityhealthtoolkit.org/building/reference/api/ - CHT Docs: https://docs.communityhealthtoolkit.org/ - CHT Community: https://forum.communityhealthtoolkit.org/ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/ckan.md b/adaptors/ckan.md index 4b4822eee779..f87736a3cb0d 100644 --- a/adaptors/ckan.md +++ b/adaptors/ckan.md @@ -221,3 +221,9 @@ to access the web API. CKAN has been implemented in [catalog.data.gov](https://catalog.data.gov), [open.canada.ca/data](https://open.canada.ca/data), and [data.humdata.org](https://data.humdata.org). + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/claude.md b/adaptors/claude.md index dcbf59b2a4b6..64b3d41dcbe0 100644 --- a/adaptors/claude.md +++ b/adaptors/claude.md @@ -43,3 +43,9 @@ technical docs on the authentication parameters required. - About Claude: https://claude.ai/ - API docs: https://www.anthropic.com/api + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/collections.md b/adaptors/collections.md index af9595e3f491..8f5545630f4c 100644 --- a/adaptors/collections.md +++ b/adaptors/collections.md @@ -349,3 +349,9 @@ And make sure that any steps which use collections have multiple adaptors set: } } ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/commcare.md b/adaptors/commcare.md index f4e4045135aa..801df058380f 100644 --- a/adaptors/commcare.md +++ b/adaptors/commcare.md @@ -347,3 +347,9 @@ CommCare has different APIs for reading vs. modifying data. Some helpful links: https://github.com/OpenFn/miracle-feet - Lwala (CommCare-Salesforce 2-way sync): https://github.com/OpenFn/lwala - myAgro (CommCare-Salesforce): https://github.com/OpenFn/myagro-commcare-sf + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/common.md b/adaptors/common.md index ff59e198ed4f..110109ccc779 100644 --- a/adaptors/common.md +++ b/adaptors/common.md @@ -31,3 +31,9 @@ each( }) ); ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/dhis2.md b/adaptors/dhis2.md index de6d77230a0e..99e5846c0db0 100644 --- a/adaptors/dhis2.md +++ b/adaptors/dhis2.md @@ -136,3 +136,10 @@ useful. In the following sections, special systems will be described. 1. DHIS2 Demo Implementations: https://github.com/OpenFn/dhis2-demo 2. Lesotho Integration connecting two DHIS2 instances: https://github.com/OpenFn/lesotho-dhis2 + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/divoc.md b/adaptors/divoc.md new file mode 100644 index 000000000000..98acff78e9fa --- /dev/null +++ b/adaptors/divoc.md @@ -0,0 +1,45 @@ +--- +title: Divoc Adaptor +--- + +## About Divoc + +DIVOC (Digital Infrastructure for Verifiable Open Credentialing) is an open-source platform designed for issuing and managing digital vaccination certificates. Developed by the eGovernments Foundation and used as the backbone for India's CoWIN platform, DIVOC has issued over 2 billion vaccination certificates across multiple countries including India, Sri Lanka, Philippines, Jamaica, and Indonesia. The platform provides WHO-compliant digital certificates that are accepted in over 120 countries worldwide. + +## Integration Options + +DIVOC supports REST API integration with OpenFn: + +**REST API**: DIVOC provides a comprehensive REST API that enables external services like OpenFn to interact with vaccination certificate management systems. This API allows you to create digital certificates, manage vaccination facilities, register beneficiaries, and generate vaccination reports programmatically. The integration is suited for scheduled certificate issuance, bulk vaccination data synchronization, and workflows that need to update DIVOC with external health system information. See [functions](/adaptors/packages/divoc-docs) for more on how to use this adaptor to work with the DIVOC API. + +## Authentication + +To connect to DIVOC, you need to provide authentication credentials: + +```json +{ + "baseUrl": "https://your-divoc-instance.example.com", + "access_token": "your_bearer_token_here", + "username": "your_username", + "password": "your_password" +} +``` + +**Required Fields:** +- `baseUrl`: The base URL of your DIVOC instance +- `username`: Your DIVOC username (required) +- `password`: Your DIVOC password (required) + +**Optional Fields:** +- `access_token`: Bearer token for API authentication (can be used instead of username/password) + + +## Helpful Links + +- [OpenFn DIVOC Adaptor](https://docs.openfn.org/adaptors/packages/divoc-readme) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/dynamics.md b/adaptors/dynamics.md index 1c13598f34ef..487c3e32650f 100644 --- a/adaptors/dynamics.md +++ b/adaptors/dynamics.md @@ -36,6 +36,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Comming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/facebook.md b/adaptors/facebook.md new file mode 100644 index 000000000000..3ac2e3899074 --- /dev/null +++ b/adaptors/facebook.md @@ -0,0 +1,41 @@ +--- +title: Facebook Adaptor +--- + +## About Facebook + +[Facebook](https://www.facebook.com/) is the world's largest social networking platform, connecting billions of people globally. Facebook provides various APIs and integration capabilities, particularly through Facebook Messenger, enabling businesses to create automated messaging experiences, customer service bots, and interactive communication workflows. + +The Facebook Messenger platform is particularly valuable for businesses seeking to provide customer support, marketing automation, and interactive customer engagement through one of the world's most popular messaging platforms. + +## Integration Options + +**Messenger API**: Facebook provides the Messenger Platform API that enables businesses to send messages, create interactive experiences, and build chatbots. The API supports rich messaging features including text, images, quick replies, and structured templates for creating engaging user interactions through Facebook Messenger. + +## Authentication + +Facebook uses OAuth 2.0 access tokens for Messenger API authentication: + +```json +{ + "access_token": "EAAGm0PX4ZCpsBAEHuZBwZBZCDEZDZD7ZC8ZBZBt7MbZA7sVZA" +} +``` + +**Authentication Components:** +- **access_token**: Facebook API access token obtained through Facebook App configuration + +Access tokens are generated through Facebook for Developers and provide access to send messages through Facebook Pages and Messenger conversations based on the app permissions and page access granted. + + +## Helpful Links + +- [Facebook for Developers](https://developers.facebook.com/) +- [OpenFn Facebook Adaptor Configuration](https://docs.openfn.org/adaptors/packages/facebook-configuration-schema) +- [OpenFn Facebook Adaptor Docs](https://docs.openfn.org/adaptors/packages/facebook-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/fhir-4.md b/adaptors/fhir-4.md index fc156a2f8d4e..0a32eba4b5df 100644 --- a/adaptors/fhir-4.md +++ b/adaptors/fhir-4.md @@ -719,3 +719,9 @@ b.patient({ identifier: $.patient. }); ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/fhir-fr.md b/adaptors/fhir-fr.md index 38ac51106d25..dc8bc61dcb04 100644 --- a/adaptors/fhir-fr.md +++ b/adaptors/fhir-fr.md @@ -12,4 +12,10 @@ See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/docu ## Build your own FHIR Adaptor See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing). -Please share any questions or feedback on [community.openfn.org](https://community.openfn.org). \ No newline at end of file +Please share any questions or feedback on [community.openfn.org](https://community.openfn.org). + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/fhir-ndr-et.md b/adaptors/fhir-ndr-et.md index 2a42c6a3ab2e..98c7e3fa3134 100644 --- a/adaptors/fhir-ndr-et.md +++ b/adaptors/fhir-ndr-et.md @@ -12,4 +12,10 @@ See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/docu ## Build your own FHIR Adaptor See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing). -Please share any questions or feedback on [community.openfn.org](https://community.openfn.org). \ No newline at end of file +Please share any questions or feedback on [community.openfn.org](https://community.openfn.org). + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/fhir.md b/adaptors/fhir.md index 91d22834dcb9..4c0b038154a4 100644 --- a/adaptors/fhir.md +++ b/adaptors/fhir.md @@ -46,3 +46,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag Have resources or links to share? Submit a PR to edit this page or post on [community.openfn.org](https://community.openfn.org). +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/formsg.md b/adaptors/formsg.md new file mode 100644 index 000000000000..e0a283ef3c9e --- /dev/null +++ b/adaptors/formsg.md @@ -0,0 +1,40 @@ +--- +title: FormSG Adaptor +--- + +## About FormSG + +[FormSG](https://form.gov.sg/) is an open-source form builder developed by the Singapore Government's Open Government Products team to digitize paper processes for government agencies. It enables secure collection of up to Confidential (Cloud-Eligible) and Sensitive (High) data with end-to-end encryption. + +## Integration Options + +FormSG supports webhook integration with OpenFn: + +**Webhooks**: FormSG provides webhook functionality that enables real-time form submission data to be sent to external applications like OpenFn. Using the official FormSG JavaScript SDK, you can securely decrypt and process form submissions as they are received. This integration is suited for automated workflow triggers, real-time data processing, and applications that need immediate response to form submissions. The webhook system includes signature verification to ensure data authenticity and security. See [functions](/adaptors/packages/formsg-docs) for more on how to use this adaptor to work with FormSG webhooks. + +## Authentication + +1. See [FormSG SDK documentation](https://github.com/opengovsg/formsg-sdk) for the latest on webhook authentication and signature verification methods. +2. When integrating with FormSG via OpenFn, you need a **Form Secret Key** which is generated when you create a form in FormSG. This key is used for decrypting submissions and verifying webhook signatures. +3. See this adaptor's [configuration docs](/adaptors/packages/formsg-configuration-schema) for more on the required authentication parameters. + +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: + +```json +{ + "formSecretKey": "your-secret-key-here", + "mode": "production", + "webhookEndpoint": "https://my-domain.com/submissions" +} +``` + + +### Implementation Examples + +_Coming soon!_ + +#### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). \ No newline at end of file diff --git a/adaptors/ghana-bdr.md b/adaptors/ghana-bdr.md new file mode 100644 index 000000000000..b8bbfadf1b48 --- /dev/null +++ b/adaptors/ghana-bdr.md @@ -0,0 +1,43 @@ +--- +title: Ghana BDR (Births and Deaths Registry) Adaptor +--- + + +## About Ghana BDR + +The Ghana Births and Deaths Registry (BDR) is the official government agency responsible for registering all births, deaths, and related vital events within Ghana's boundaries. Established under the Registration of Births and Deaths Act 1027 of 2020, the BDR maintains comprehensive records of vital statistics and provides certified documentation for citizens. The registry serves as the primary source for birth certificates, death certificates, adoption records, and other vital registration services essential for legal identification and government services in Ghana. + +## Integration Options + +Ghana BDR supports REST API integration with OpenFn: + +**REST API**: The Ghana BDR system provides API access for vital registration services, enabling external systems like OpenFn to interact with birth and death registration data. See [functions](/adaptors/packages/ghana-bdr-docs) for more on how to use this adaptor to work with the Ghana BDR API. + +## Authentication + +To connect to Ghana BDR, you need to provide authentication credentials: + +```json +{ + "baseUrl": "https://your-bdr-instance.gov.gh", + "username": "your_username", + "password": "your_password" +} +``` + +**Required Fields:** +- `baseUrl`: The base URL of the Ghana BDR system +- `username`: Your BDR system username (required) +- `password`: Your BDR system password (required) + + +## Helpful Links + +- [Ghana BDR Official Website](https://bdr.gov.gh/) +- [OpenFn Ghana BDR Adaptor](https://docs.openfn.org/adaptors/packages/ghana-bdr-readme) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/ghana-nia.md b/adaptors/ghana-nia.md new file mode 100644 index 000000000000..319d43f95c36 --- /dev/null +++ b/adaptors/ghana-nia.md @@ -0,0 +1,39 @@ +--- +title: Ghana NIA (National Identification Authority) Adaptor +--- + +## About Ghana NIA + +The Ghana National Identification Authority (NIA) is a statutory body established by the National Identification Authority Act, 2006 (Act 707) to create, maintain, provide and promote the use of national identity cards known as Ghana Cards. The NIA delivers exceptional identity services through a digitalized ecosystem for the promotion of safety, security, good governance and development in Ghana. The authority manages the National Identification System (NIS) that serves millions of Ghanaians and eligible foreigners, providing secure digital identity services for various government and private sector applications. + +## Integration Options + +Ghana NIA supports REST API integration with OpenFn: + +**REST API**: The Ghana NIA system provides API access for national identification services, enabling external systems like OpenFn to interact with identity verification, card issuance, and demographic data. See [functions](/adaptors/packages/ghana-nia-docs) for more on how to use this adaptor to work with the Ghana NIA API. + +## Authentication + +To connect to Ghana NIA, you need to provide authentication credentials: + +```json +{ + "baseUrl": "https://your-nia-instance.gov.gh", + "merchantKey": "your_merchant_key" +} +``` + +**Required Fields:** +- `baseUrl`: The base URL of the Ghana NIA system +- `merchantKey`: Your NIA merchant key for API authentication (required) + +## Helpful Links + +- [Ghana NIA Official Website](https://nia.gov.gh/) +- [OpenFn Ghana NIA Adaptor](https://docs.openfn.org/adaptors/packages/ghana-nia-readme) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/gmail.md b/adaptors/gmail.md index 185d900ae5d6..9ca0362b8b7d 100644 --- a/adaptors/gmail.md +++ b/adaptors/gmail.md @@ -37,5 +37,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/godata.md b/adaptors/godata.md index 9b505092ecb6..67097b00a758 100644 --- a/adaptors/godata.md +++ b/adaptors/godata.md @@ -39,3 +39,9 @@ supported by `language-godata`. ## Implementation Examples See Go.Data docs site: https://worldhealthorganization.github.io/godata/integration-scripts/ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/googledrive.md b/adaptors/googledrive.md new file mode 100644 index 000000000000..6d17aeba691d --- /dev/null +++ b/adaptors/googledrive.md @@ -0,0 +1,41 @@ +--- +title: Google Drive Adaptor +--- + +## About Google Drive + +[Google Drive](https://www.google.com/drive/) is Google's cloud-based file storage and synchronization service that allows users to store files online and access them from any computer or mobile device. Google Drive provides secure cloud storage, real-time collaboration capabilities, and seamless integration with Google Workspace applications including Docs, Sheets, and Slides. + +## Integration Options + +**REST API**: Google Drive provides comprehensive REST APIs through the Google Drive API, enabling developers to create, read, update, and manage files and folders programmatically. The API supports OAuth 2.0 authentication and provides access to metadata, content manipulation, and sharing permissions management. + +## Authentication + +Google Drive uses OAuth 2.0 access tokens for API authentication: + +```json +{ + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI" +} +``` + +**Authentication Components:** +- **access_token**: OAuth 2.0 access token obtained through Google's authentication flow + +Access tokens can be generated through Google Cloud Console and provide scoped access to Google Drive resources based on the permissions granted during the OAuth flow. + + + +## Helpful Links + + +- [Google Drive API Documentation](https://developers.google.com/drive/api) +- [OpenFn Google Drive Adaptor Configuration](https://docs.openfn.org/adaptors/packages/googledrive-configuration-schema) +- [OpenFn Google Drive Adaptor Docs](https://docs.openfn.org/adaptors/packages/googledrive-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/googlehealthcare.md b/adaptors/googlehealthcare.md index 8fc8fe0ea027..71723ed044e9 100644 --- a/adaptors/googlehealthcare.md +++ b/adaptors/googlehealthcare.md @@ -36,7 +36,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/googlesheets.md b/adaptors/googlesheets.md index 37db9ee2507a..5faf5e7ab7ea 100644 --- a/adaptors/googlesheets.md +++ b/adaptors/googlesheets.md @@ -145,3 +145,10 @@ that shows us how to get data via a REST API and push it to Google Sheet. - [Google Sheets API Overview](https://developers.google.com/sheets/api/guides/concepts) - OpenFn Workflow Tutorial: [HTTP-to-GoogleSheets](https://docs.openfn.org/documentation/tutorials/http-to-googlesheets) + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/hive.md b/adaptors/hive.md index 8f7f82827dfc..48a9032abe69 100644 --- a/adaptors/hive.md +++ b/adaptors/hive.md @@ -35,6 +35,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/http.md b/adaptors/http.md index 295cb231281d..efc36b906860 100644 --- a/adaptors/http.md +++ b/adaptors/http.md @@ -34,6 +34,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. UNICEF Primero - UNHCR Progres Interoperability: [https://github.com/OpenFn/primero-progres](https://github.com/OpenFn/primero-progres) 2. UNICEF Thailand Primero Interoperability: [https://openfn.github.io/primero-thailand/](https://openfn.github.io/primero-thailand/) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/hubtel.md b/adaptors/hubtel.md index fcea9b3a7fe8..36e46d1c8b4d 100644 --- a/adaptors/hubtel.md +++ b/adaptors/hubtel.md @@ -40,6 +40,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/inform.md b/adaptors/inform.md new file mode 100644 index 000000000000..a490815acd37 --- /dev/null +++ b/adaptors/inform.md @@ -0,0 +1,40 @@ +--- +title: Inform Adaptor +--- + +## About Inform + +[Inform](https://inform.unicef.org/) is UNICEF's platform for building forms and surveys, collecting field data (even offline), and viewing results in simple dashboards. Inform enables organizations to create digital forms, collect data in the field (with offline capabilities), and analyze results through intuitive dashboards and reporting tools. + +## Integration Options + +Inform supports integration through its REST API, which enables external services like OpenFn to: + +1. **REST API**: Pull data from Inform or push data from external applications to Inform. This option is suited for scheduled, bulk syncs or workflows that need to update data in Inform with external information. See [functions](/adaptors/packages/inform-docs) for more on how to use this adaptor to work with the API. + +2. **Data Export**: Export collected survey and form data for analysis and integration with external systems like DHIS2, databases, or reporting platforms. + +## Authentication + +When integrating with Inform via OpenFn, the primary authentication method supported is: **Access Token**. + +See this adaptor's [Configuration docs](/adaptors/packages/inform-configuration-schema) for more on required authentication parameters. + +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: + +```json +{ + "baseUrl": "https://data.inform.unicef.org", + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI" +} +``` + +### Helpful Links + +1. [Inform Platform](https://inform.unicef.org/) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/intro.mdx b/adaptors/intro.mdx index 4dfe9bfdc9ac..c3c3fcb355e5 100644 --- a/adaptors/intro.mdx +++ b/adaptors/intro.mdx @@ -168,7 +168,7 @@ Or build your own (see below)! ## Building and extending adaptors -See the [Github Adaptors wiki](https://github.com/OpenFn/adaptors/wiki) for the +See the [Github Adaptors wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for the technical guide to developing adaptors. Adaptors' source code and technical documentation for developing or extending diff --git a/adaptors/intuit.md b/adaptors/intuit.md index 09d4890261e9..5c22d22cca67 100644 --- a/adaptors/intuit.md +++ b/adaptors/intuit.md @@ -33,3 +33,9 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [API Documentation](https://developer.intuit.com/) 2. [Webhook Configuration Documentation](https://developer.intuit.com/app/developer/qbo/docs/api/webhooks) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/khanacademy.md b/adaptors/khanacademy.md new file mode 100644 index 000000000000..a923f7169d7a --- /dev/null +++ b/adaptors/khanacademy.md @@ -0,0 +1,47 @@ +--- +title: Khan Academy Adaptor +--- + +## About Khan Academy + +[Khan Academy](https://www.khanacademy.org/) is a nonprofit educational platform that provides a free, world-class education for anyone, anywhere. Founded with the mission to democratize learning, Khan Academy offers personalized learning experiences through interactive exercises, instructional videos, and comprehensive curriculum covering subjects from kindergarten through early college. + +Khan Academy serves millions of students worldwide, providing essential educational resources for K-12 education, college preparation, and lifelong learning. + +## Integration Options + +**REST API**: Khan Academy provides API access for educational data integration, enabling external applications to retrieve user progress, learning analytics, and curriculum information. The API supports OAuth-based authentication and provides access to student performance data and content metadata for educational technology integrations. + +## Authentication + +Khan Academy uses OAuth-based authentication with multiple credential components: + +```json +{ + "email": "test@openfn.org", + "password": "@some(!)Strongpassword", + "secretKey": "otherThiNGfSECret", + "consumerKey": "somEThINGkeyish" +} +``` + +**Authentication Components:** +- **email**: Your Khan Academy account email address +- **password**: Your Khan Academy account password +- **consumerKey**: OAuth consumer key for API access +- **secretKey**: OAuth secret key for request signing + +OAuth credentials enable secure access to Khan Academy's educational data while maintaining user privacy and data protection. + + +## Helpful Links + +- [Khan Academy API Documentation](https://github.com/Khan/khan-api) +- [OpenFn Khan Academy Adaptor Configuration](https://docs.openfn.org/adaptors/packages/khanacademy-configuration-schema) +- [OpenFn Khan Academy Adaptor Docs](https://docs.openfn.org/adaptors/packages/khanacademy-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/kobotoolbox.md b/adaptors/kobotoolbox.md index ccbfe51b2994..707e89a68a84 100644 --- a/adaptors/kobotoolbox.md +++ b/adaptors/kobotoolbox.md @@ -228,3 +228,9 @@ also be implemented to send GET/POST/PUT requests to the Kobo APIs. See the `ConSoSci` GitHub repo for several example Kobo-to-database jobs: https://github.com/OpenFn/consosci + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/library-intro.md b/adaptors/library-intro.md index 377b7ef684d8..1616a7ad18a7 100644 --- a/adaptors/library-intro.md +++ b/adaptors/library-intro.md @@ -78,3 +78,9 @@ We're planning to expand both the API and the library searching/browsing experience in the future. We'd like to provide a way for users to "upvote" or "downvote" certain jobs (think: StackOverflow) which they found useful. Get in touch if you're interested in helping out! + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/magpi.md b/adaptors/magpi.md index 8153ceba4906..05a1a8f85832 100644 --- a/adaptors/magpi.md +++ b/adaptors/magpi.md @@ -15,3 +15,9 @@ fetchSurveyData({ ``` Every time this job runs it will only fetch new data, by default. + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mailchimp.md b/adaptors/mailchimp.md index 221d9cbde410..2d7ee4fb0428 100644 --- a/adaptors/mailchimp.md +++ b/adaptors/mailchimp.md @@ -36,6 +36,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. GIFE Project - Mailchimp -> Salesforce sync: [https://github.com/OpenFn/gife](https://github.com/OpenFn/gife) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mailgun.md b/adaptors/mailgun.md index 6195a400d204..ccf8c916a539 100644 --- a/adaptors/mailgun.md +++ b/adaptors/mailgun.md @@ -34,5 +34,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 2. [Event Webhooks](https://documentation.mailgun.com/en/latest/api-events.html#event-webhooks) 3. [Support and Community](https://help.mailgun.com/) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/maximo.md b/adaptors/maximo.md new file mode 100644 index 000000000000..6ba4becaf74b --- /dev/null +++ b/adaptors/maximo.md @@ -0,0 +1,43 @@ +--- +title: Maximo Adaptor +--- + +## About Maximo + +[IBM Maximo Application Suite](https://www.ibm.com/products/maximo) is the industry-leading Enterprise Asset Management (EAM) solution designed to manage critical assets, reduce downtime, and improve operational efficiency. Built on decades of industry expertise, Maximo provides end-to-end management of assets from procurement and maintenance to decommissioning, ensuring optimal performance throughout the entire asset lifecycle. + +Maximo is essential for organizations managing critical infrastructure, manufacturing equipment, facilities, and transportation assets across industries including energy, utilities, manufacturing, government, and transportation. + +## Integration Options + +**REST API**: IBM Maximo provides comprehensive REST API access through the Maximo REST API, enabling external applications to interact with asset data, work orders, inventory, and maintenance schedules. The API supports full CRUD operations and integrates with Maximo's workflow engine for automated business processes. + +## Authentication + +Maximo uses HTTP basic authentication for API access: + +```json +{ + "baseUrl": "https://maximo-demo76.mro.com", + "username": "test@openfn.org", + "password": "@some(!)password" +} +``` + +**Authentication Components:** +- **baseUrl**: Your Maximo instance base URL +- **username**: Maximo user account with appropriate API permissions +- **password**: User account password + + + +## Helpful Links + +- [OpenFn Maximo Adaptor Configuration](https://docs.openfn.org/adaptors/packages/maximo-configuration-schema) +- [OpenFn Maximo Adaptor Docs](https://docs.openfn.org/adaptors/packages/maximo-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/medicmobile.md b/adaptors/medicmobile.md new file mode 100644 index 000000000000..c3aee67c9195 --- /dev/null +++ b/adaptors/medicmobile.md @@ -0,0 +1,35 @@ +--- +title: Medicmobile Adaptor +--- + +## About Medicmobile + +[Medicmobile](https://medic.org/about/) is a nonprofit that builds the open-source Community Health Toolkit (CHT) and partners with governments and NGOs to equip community health workers, often in hard-to-reach areas with offline-first tools for case management, decision support, and health analytics. + +## Integration Options + +Rest API: Medicmobile has a REST API that enables external services like OpenFn to pull data from Medicmobile, or push data from external apps to Medicmobile. This option is suited for scheduled, bulk syncs or workflows that must update data in Medicmobile with external information. See [functions](/adaptors/packages/medicmobile-docs) for more on how to use this adaptor to work with the API. + +## Authentication + +See [Medicmobile docs](https://docs.communityhealthtoolkit.org/building/reference/api/#replication-limit) for the latest on supported authentication methods. +[See our configuration docs](/adaptors/packages/medicmobile-configuration-schema) to learn more. + +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: + +```json + +{ + "server": "https://standard.app.medicmobile.org", + "username": "admin", + "password": "@super(!)Secret", + "db": "medic" +} + +``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/memento.md b/adaptors/memento.md new file mode 100644 index 000000000000..29ef18f74e6c --- /dev/null +++ b/adaptors/memento.md @@ -0,0 +1,43 @@ +--- +title: Memento Database Adaptor +--- + +## About Memento Database + +[Memento Database](https://mementodatabase.com/) is a powerful, customizable database application that enables users to organize any type of data with a no-code approach. + +## Integration Options + +Memento Database supports REST API integration with OpenFn: + +**REST API**: Memento Database provides a Cloud API that enables external services like OpenFn to interact with libraries (databases), entries (records), and files. This API allows you to create, read, update, and delete records, manage database structures, and synchronize data programmatically. + +## Authentication + +1. See [Memento Database API docs](https://mementodatabase.docs.apiary.io/) for the latest on supported authentication methods. +2. When integrating with Memento Database via OpenFn, the primary authentication method is **API Key**. You can generate an API key from your Memento Database account settings. + +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: + +```json +{ + "apiKey": "your_memento_database_api_key_here", + "baseUrl": "https://api.mementodatabase.com" +} +``` + +### Helpful Links + +1. [Memento Cloud API Documentation](https://mementodatabase.docs.apiary.io/) +2. [Memento Database Official Website](https://mementodatabase.com/) + + +### Implementation Examples + +_Coming soon!_ + +#### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). \ No newline at end of file diff --git a/adaptors/mogli.md b/adaptors/mogli.md new file mode 100644 index 000000000000..0928dc8dd78c --- /dev/null +++ b/adaptors/mogli.md @@ -0,0 +1,49 @@ +--- +title: Mogli Adaptor +--- + +## About Mogli + +Mogli is a mobile messaging platform that enables SMS communication and management through its API. The platform provides capabilities for sending, receiving, and managing SMS messages, making it suitable for organizations that need reliable mobile messaging integration for notifications, alerts, and two-way communication workflows. + + +Mogli is particularly useful for organizations needing mobile engagement capabilities, emergency notifications, field communication, and customer outreach via SMS. + +## Integration Options + +**REST API**: Mogli provides a REST API that enables external applications to send SMS messages, receive inbound messages, and manage communication workflows. The API supports authentication through multiple security layers including username/password, security tokens, and API secrets for comprehensive access control. + +## Authentication + +Mogli uses multiple authentication components for secure API access: + +```json +{ + "loginUrl": "https://www.orange-or-airtel-or-vodafone.com/api/", + "username": "admin", + "password": "@secret(!)Pass", + "securityToken": "dGF5bG9yOnNlY3JldA==", + "secret": "someotherThiNGfSECret" +} +``` + +**Authentication Components:** +- **loginUrl**: The Mogli API endpoint URL +- **username**: Your Mogli account username +- **password**: Your Mogli account password +- **securityToken**: Base64-encoded security token for API access +- **secret**: Additional secret key for enhanced security + +All API requests require this multi-layer authentication approach to ensure secure message transmission. + + +## Helpful Links + +- [OpenFn Mogli Adaptor Configuration](https://docs.openfn.org/adaptors/packages/mogli-configuration-schema) +- [OpenFn Mogli Adaptor Docs](https://docs.openfn.org/adaptors/packages/mogli-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mojatax.md b/adaptors/mojatax.md index 5012793bcea5..bd11f800c9cf 100644 --- a/adaptors/mojatax.md +++ b/adaptors/mojatax.md @@ -48,3 +48,10 @@ something like this: - Mojatax API documentation on Postman: https://documenter.getpostman.com/view/5385860/2s93RMVao6#intro + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mongodb.md b/adaptors/mongodb.md index 5c6f560b0428..ec839f92c3e5 100644 --- a/adaptors/mongodb.md +++ b/adaptors/mongodb.md @@ -29,8 +29,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [MongoDB documentation](https://www.mongodb.com/docs/) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - - - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/moodle.md b/adaptors/moodle.md index 4c7c5a4f7716..d1b7c585d8c9 100644 --- a/adaptors/moodle.md +++ b/adaptors/moodle.md @@ -115,3 +115,9 @@ fn(state => { )(state); }); ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/motherduck.md b/adaptors/motherduck.md new file mode 100644 index 000000000000..636bdd38ea06 --- /dev/null +++ b/adaptors/motherduck.md @@ -0,0 +1,44 @@ +--- +title: MotherDuck Adaptor +--- + +## About MotherDuck + +[MotherDuck](https://motherduck.com) is a serverless cloud data warehouse built on DuckDB that makes big data feel small. It combines the power of DuckDB's analytical engine with cloud scalability, offering ultra-fast analytics without the operational complexity of traditional data warehouses. + +## Integration Options + +MotherDuck supports REST API integration with OpenFn: + +**REST API**: MotherDuck provides API access that enables external services like OpenFn to interact with cloud databases, execute SQL queries, and manage data warehousing operations. See [functions](/adaptors/packages/motherduck-docs) for more on how to use this adaptor to work with the MotherDuck API. + +## Authentication + +1. See [MotherDuck docs](https://motherduck.com/docs/getting-started/interfaces/client-apis/connect-query-from-python/installation-authentication/) for the latest on supported authentication methods. +2. When integrating with MotherDuck via OpenFn, the primary authentication method is **Token**. You can generate a token from your MotherDuck account settings. +3. See this adaptor's [Configuration docs](/adaptors/packages/motherduck-configuration-schema) for more on the required authentication parameters. + +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: + +```json +{ + "token": "token_abc123...", + "database": "my_database", + "sessionHint": "primary" +} +``` + +### Helpful Links + +1. [MotherDuck Documentation](https://motherduck.com/docs/) +2. [MotherDuck Official Website](https://motherduck.com/) + +### Implementation Examples + +_Coming soon!_ + +#### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). \ No newline at end of file diff --git a/adaptors/mpesa.md b/adaptors/mpesa.md new file mode 100644 index 000000000000..c28b64dd1161 --- /dev/null +++ b/adaptors/mpesa.md @@ -0,0 +1,38 @@ +--- +title: Mpesa Adaptor +--- + +## About Mpesa + +[Mpesa](https://developer.safaricom.co.ke/Documentation) is a mobile money transfer service in Kenya that allows users to store and transfer money through their mobile phones. + +## Integration Options + +**Rest API:** Mpesa offers a REST API that enables external applications to interact with its services. This option is ideal for applications requiring scheduled or bulk synchronization with Mpesa. Refer to the Mpesa REST API [documentation](https://developer.safaricom.co.ke/Documentation) for detailed guidelines on endpoints and payload formats. + +## Authentication +See [Mpesa docs](https://developer.safaricom.co.ke/Documentation) for the latest on supported authentication methods. +[See our configuration docs](/adaptors/packages/mpesa-configuration-schema) to learn more. + +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: + +```json + +{ + "short_code": "654321", + "pass_key": "bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919", + "consumer_key": "GA2PNftcXvv2uC2VdgNjxXyvF8eZ4td6iBsL7N7N2ZFnXzf3", + "consumer_secret": "zKjr2j0jjihCtzIwzGtgnV0YgP82jZf1hY9RW6HygntWG6AGuf4tAUe3E5tPtiyA" +} + +``` + +### Helpful Links + +1. [Mpesa Documentation](https://developer.safaricom.co.ke/) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/msgraph.md b/adaptors/msgraph.md index ab0bff3958bd..d19b09b999ee 100644 --- a/adaptors/msgraph.md +++ b/adaptors/msgraph.md @@ -96,3 +96,9 @@ and/or consult with your system administrator.** - [MS Graph Overview](https://learn.microsoft.com/en-us/graph/overview) - [MS Graph OAuth Scopes](https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mssql.md b/adaptors/mssql.md index 50b809a17ac6..9cd4b160eff4 100644 --- a/adaptors/mssql.md +++ b/adaptors/mssql.md @@ -30,8 +30,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [MSSQL documentation](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - - - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/msupply.md b/adaptors/msupply.md new file mode 100644 index 000000000000..5a9b2e2fe742 --- /dev/null +++ b/adaptors/msupply.md @@ -0,0 +1,38 @@ +--- +title: Msupply Adaptor +--- + +## About Msupply + +Msupply is an open source software that is used to automate pharmaceutical supply chain systems. + +## Integration Options + +GraphQL API: Msupply has a GraphQL API that enables external services like OpenFn to pull data from Msupply, or push data from external apps to Msupply. Refer to the Msupply GRraphQL API [documentation](https://docs.msupply.foundation/docs/developer/graphql/) for detailed guidelines on endpoints and payload formats. + +## Authentication +See [Msupply docs](https://docs.msupply.foundation/docs/developer/graphql/) for the latest on supported authentication methods. +[See our configuration docs](/adaptors/packages/msupply-configuration-schema) to learn more. + + +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: + +```json + +{ + "password": "@some(!)Str0ngp4ss0w0rd", + "username": "test@openfn.org", + "baseUrl": "https://example.com" +} + +``` + +### Helpful Links + +1. [Msupply Documentation](https://docs.msupply.foundation/docs/introduction/introduction/) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mtn-momo.md b/adaptors/mtn-momo.md new file mode 100644 index 000000000000..a4e7b66647e0 --- /dev/null +++ b/adaptors/mtn-momo.md @@ -0,0 +1,45 @@ +--- +title: MTN-Momo Adaptor +--- + +## About Mtn-Momo + +[Mtn-Momo](https://momodeveloper.mtn.com/api-documentation/api-description) is a mobile money transfer service in Kenya that allows users to store and transfer money through their mobile phones. + +## Integration Options + +**Rest API:** Mtn-Momo offers a REST API that enables external applications to interact with its services. Refer to the Mtn-Momo REST API [documentation](https://momodeveloper.mtn.com/api-documentation/getting-started) for detailed guidelines on endpoints and payload formats. + +## Authentication + +See [Mtn-Momo docs](https://momodeveloper.mtn.com/api-documentation/api-description) for the latest on supported authentication methods. +[See our configuration docs](/adaptors/packages/mtn-momo-configuration-schema) to learn more. + +Mtn-Momo supports two primary authentication methods: + +1. **Subscription Key** is passed to all request headers for all the requests. + +2. **API User and API Key** + +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: + +```json + +{ + "api_key": "630ee209443d787927b08b3c57902", + "api_user": "630ee209443d787927b08b3c57902", + "subscription_key": "630ee209443d787927b08b3c57902", + "baseUrl": "https://sandbox.momodeveloper.mtn.com/" +} + +``` + +### Helpful Links + +1. [Mtn-Momo Documentation](https://momodeveloper.mtn.com/api-documentation) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/mysql.md b/adaptors/mysql.md index bc64964a31d9..b3fddf9632db 100644 --- a/adaptors/mysql.md +++ b/adaptors/mysql.md @@ -30,8 +30,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [MySQL documentation](https://dev.mysql.com/doc/) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - - - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/nexmo.md b/adaptors/nexmo.md new file mode 100644 index 000000000000..b2166cbaf33b --- /dev/null +++ b/adaptors/nexmo.md @@ -0,0 +1,43 @@ +--- +title: Nexmo Adaptor +--- + +## About Nexmo + +[Nexmo](https://www.vonage.com/) (now part of Vonage) is a leading cloud communications platform that provides APIs for SMS, voice, video, and messaging services. Vonage's Communication APIs enable developers to embed real-time communications capabilities into applications, websites, and business workflows with global reach and enterprise-grade reliability. + +Nexmo/Vonage is particularly valuable for businesses needing reliable global communications, customer engagement platforms, authentication systems, and omnichannel messaging solutions. + +## Integration Options + +**REST API**: Nexmo provides comprehensive REST APIs for all communication services, enabling developers to send SMS messages, make voice calls, verify phone numbers, and access detailed analytics. The APIs support multiple authentication methods and provide real-time delivery status and detailed reporting. + +## Authentication + +Nexmo uses API key and secret-based authentication for accessing communication services: + +```json +{ + "apiKey": "mYaP1K3y", + "apiSecret": "supersecret" +} +``` + +**Authentication Components:** +- **apiKey**: Your Nexmo API key for identifying your account +- **apiSecret**: Your Nexmo API secret for authenticating requests + +API credentials can be obtained from the Vonage Dashboard and provide access to all Nexmo communication services. + +## Helpful Links + +- [Vonage Developer Center](https://developer.vonage.com/) +- [SMS API Documentation](https://developer.vonage.com/messaging/sms/overview) +- [OpenFn Nexmo Adaptor Configuration](https://docs.openfn.org/adaptors/packages/nexmo-configuration-schema) +- [OpenFn Nexmo Adaptor Docs](https://docs.openfn.org/adaptors/packages/nexmo-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/ocl.md b/adaptors/ocl.md index 416a233b7369..23847510d391 100644 --- a/adaptors/ocl.md +++ b/adaptors/ocl.md @@ -36,3 +36,9 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag ## Implementation Examples 1. OpenFn Prototype for Médecins Sans Frontières (MSF) LIME Project - OpenMRS -> OCL -> DHIS2 sync: https://github.com/OpenFn/openfn-lime + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/odk.md b/adaptors/odk.md index bbb120bd0256..03175cb5eac5 100644 --- a/adaptors/odk.md +++ b/adaptors/odk.md @@ -47,3 +47,9 @@ Every time this job runs it will get of all submissions and write them to } } ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/odoo.md b/adaptors/odoo.md index 290cf475d994..836b8ffafa83 100644 --- a/adaptors/odoo.md +++ b/adaptors/odoo.md @@ -41,6 +41,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/ona.md b/adaptors/ona.md index 194b47619982..2a4a62aac281 100644 --- a/adaptors/ona.md +++ b/adaptors/ona.md @@ -17,3 +17,10 @@ that walks users through webhook creation. will forward data as JSON. 6. Check to see that, once a form is submitted, it is forwarded to your OpenFn inbox. + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openboxes.md b/adaptors/openboxes.md new file mode 100644 index 000000000000..80f2d8c371b2 --- /dev/null +++ b/adaptors/openboxes.md @@ -0,0 +1,38 @@ +--- +title: OpenBoxes Adaptor +--- + +## About OpenBoxes + +[OpenBoxes](https://openboxes.com/about/) is an open-source supply chain and inventory management system, born after the 2010 Haiti earthquak. Built for low-resource healthcare and disaster-relief settings, with features like inventory, lot/expiry and shipment tracking, purchase orders, requisitions, and customizable reports. + +## Integration Options + +**Rest API:** OpenBoxes offers a REST API that enables external applications to interact with its services. Refer to the OpenBoxes REST API [documentation](https://docs.openboxes.com/en/develop/api-guide/getting-started/) for detailed guidelines on endpoints and payload formats. + +## Authentication + +See [OpenBoxes docs](https://docs.openboxes.com/en/develop/api-guide/getting-started/) for the latest on supported authentication methods. +[See our configuration docs](/adaptors/packages/openboxes-configuration-schema) to learn more. + +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: + +```json + +{ + "password": "@some(!)Str0ngp4ss0w0rd", + "username": "test@openfn.org", + "baseUrl": "https://demo.openboxes.com/openboxes/api" +} + +``` + +### Helpful Links + +1. [OpenBoxes Documentation](https://momodeveloper.mtn.com/api-documentation) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/opencrvs.md b/adaptors/opencrvs.md index 6a49d23bf846..e2f81e87923f 100644 --- a/adaptors/opencrvs.md +++ b/adaptors/opencrvs.md @@ -60,3 +60,9 @@ JSON credential type, then your configuration will look something like this: 1. [OpenCRVS Documentation](https://documentation.opencrvs.org/) 2. [OpenCRVS API Reference](https://documentation.opencrvs.org/technology/interoperability) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openfn.md b/adaptors/openfn.md new file mode 100644 index 000000000000..3cbc12f0027b --- /dev/null +++ b/adaptors/openfn.md @@ -0,0 +1,66 @@ +--- +title: OpenFn Adaptor +--- + +## About OpenFn + +[OpenFn](https://www.openfn.org/) is an open-source data integration platform designed to automate workflows and connect health and humanitarian systems. The platform enables organizations to build, deploy, and monitor automated data pipelines that sync data between different systems, trigger workflows based on incoming data, and transform information across various formats and standards. + + +## Integration Options + +**REST API**: The OpenFn adaptor provides access to OpenFn's v1 API, enabling programmatic management of jobs, triggers, credentials, and workflow executions. This allows for automation of OpenFn platform operations, monitoring workflow performance, and integrating OpenFn capabilities into external applications and dashboards. + +## Authentication + +The OpenFn adaptor uses API token authentication to access the OpenFn platform: + +```json +{ + "baseUrl": "https://app.openfn.org", + "access_token": "your_openfn_api_token" +} +``` + +**Authentication Components:** +- **baseUrl**: The OpenFn platform URL (defaults to https://app.openfn.org) +- **access_token**: Your OpenFn API token for authentication + +API tokens can be generated from your OpenFn account settings and provide programmatic access to your projects and workflows. + +### Making API Requests + +```js +// Get all jobs for a specific project +request({ + method: 'get', + path: 'jobs', + params: { + project_id: 490, + }, +}); + +// Create a new job +request({ + method: 'post', + path: 'jobs', + data: { + trigger_id: 1, + expression: 'steps()', + }, +}, state => { + console.log('Job created successfully!'); + return state; +}); +``` + +## Helpful Links + +- [OpenFn Adaptor Configuration](https://docs.openfn.org/adaptors/packages/openfn-configuration-schema) +- [OpenFn Adaptor Docs](https://docs.openfn.org/adaptors/packages/openfn-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openhim.md b/adaptors/openhim.md index 2021091a4dc5..1e6d9fd3d6f1 100644 --- a/adaptors/openhim.md +++ b/adaptors/openhim.md @@ -36,6 +36,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openimis.md b/adaptors/openimis.md index 39ab05e6131a..f1f10877c75c 100644 --- a/adaptors/openimis.md +++ b/adaptors/openimis.md @@ -40,4 +40,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openlmis.md b/adaptors/openlmis.md index b9f576419b65..d4a0f7475953 100644 --- a/adaptors/openlmis.md +++ b/adaptors/openlmis.md @@ -41,4 +41,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openmrs.md b/adaptors/openmrs.md index 521b2934ce6f..a9d3a2844906 100644 --- a/adaptors/openmrs.md +++ b/adaptors/openmrs.md @@ -179,3 +179,9 @@ fhir.get('Encounter', { 1. OpenFn Prototype for Médecins Sans Frontières (MSF) LIME Project - OpenMRS -> DHIS2 sync: [https://github.com/OpenFn/openfn-lime](https://github.com/OpenFn/openfn-lime) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/openspp.md b/adaptors/openspp.md index dd3b964ea4fc..6c46c37a972d 100644 --- a/adaptors/openspp.md +++ b/adaptors/openspp.md @@ -56,3 +56,9 @@ JSON credential type, then your configuration will look something like this: ### Implementation Examples _Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/pdfshift.md b/adaptors/pdfshift.md index 601c383de995..58830057013b 100644 --- a/adaptors/pdfshift.md +++ b/adaptors/pdfshift.md @@ -39,3 +39,9 @@ JSON credential type, then your configuration will look something like this: ### Helpful Links 1. [PDFShift Documentation](https://docs.pdfshift.io/#introduction) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/pesapal.md b/adaptors/pesapal.md new file mode 100644 index 000000000000..56092d6f0eee --- /dev/null +++ b/adaptors/pesapal.md @@ -0,0 +1,81 @@ +--- +title: Pesapal Adaptor +--- + +## About Pesapal + +[Pesapal](https://www.pesapal.com/) is a leading payment gateway service provider in East Africa, enabling businesses to accept payments from customers using various payment methods including mobile money, cards, and bank transfers. Pesapal supports payments in multiple currencies and provides secure, PCI/DSS compliant payment processing for e-commerce platforms, mobile applications, and other digital services. + +## Integration Options + +Pesapal supports integration through its REST API, which enables external services like OpenFn to: + +1. **REST API**: Submit payment orders, query transaction status, and manage payment workflows. This option is suited for e-commerce integrations, automated billing systems, or workflows that need to process payments and track their status. See [functions](/adaptors/packages/pesapal-docs) for more on how to use this adaptor to work with the API. + +2. **IPN (Instant Payment Notification)**: Receive real-time notifications when payment status changes. This option is suited for event-based workflows that need immediate updates on payment completion or failure. + +## API Versions + +Pesapal offers multiple API versions: + +- **API 3.0 (JSON)**: The current version using JSON REST APIs with Bearer token authentication +- **API 2.0 (XML)**: Legacy version using XML and OAuth 1.0 authentication (deprecated) + +This adaptor supports both versions, with API 3.0 being recommended for new integrations. + +## Authentication + +### API 3.0 Authentication + +When integrating with Pesapal API 3.0 via OpenFn, the authentication method uses **Consumer Key and Consumer Secret** to generate a Bearer token: + +```json +{ + "baseUrl": "https://pay.pesapal.com/v3", + "consumer_key": "your-consumer-key", + "consumer_secret": "your-consumer-secret" +} +``` + +For testing/sandbox environment: +```json +{ + "baseUrl": "https://cybqa.pesapal.com/pesapalv3", + "consumer_key": "your-sandbox-consumer-key", + "consumer_secret": "your-sandbox-consumer-secret" +} +``` + +### API 2.0 Authentication (Legacy) + +For legacy integrations using API 2.0: + +```json +{ + "baseUrl": "https://www.pesapal.com", + "consumer_key": "your-consumer-key", + "consumer_secret": "your-consumer-secret" +} +``` + +See this adaptor's [Configuration docs](/adaptors/packages/pesapal-configuration-schema) for more on required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. + + +### Helpful Links + +1. [Pesapal API 3.0 Documentation](https://developer.pesapal.com/how-to-integrate/e-commerce/api-30-json/api-reference) +3. [Pesapal Postman Collection](https://documenter.getpostman.com/view/6715320/UyxepTv1) +4. [Test Credentials](https://developer.pesapal.com/api3-demo-keys.txt) +5. [Merchant Registration](https://www.pesapal.com/dashboard/account/register) + +### Implementation Examples + +_Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/postgresql.md b/adaptors/postgresql.md index d37d3998d720..9c7c2c5116bc 100644 --- a/adaptors/postgresql.md +++ b/adaptors/postgresql.md @@ -120,3 +120,10 @@ OpenFn implementations can leverage the https://github.com/OpenFn/consosci 2. Cambodia Primero < > ONA Database: https://github.com/OpenFn/primero-ona-dashboard + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/powerbi.md b/adaptors/powerbi.md index 01e3579343e0..2068b6eab51a 100644 --- a/adaptors/powerbi.md +++ b/adaptors/powerbi.md @@ -33,3 +33,9 @@ above use case. ![Tableau Data Flow Visualization](/img/survey_db_powerbi.webp) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/primero.md b/adaptors/primero.md index 155ce35c995b..8e349ba2bdbe 100644 --- a/adaptors/primero.md +++ b/adaptors/primero.md @@ -106,3 +106,10 @@ Primero API V1 (to be deprecated). https://github.com/OpenFn/primero-progres 4. Thailand: UNICEF Primero < > MoPH HIS: https://github.com/OpenFn/primero-thailand + + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/progres.md b/adaptors/progres.md new file mode 100644 index 000000000000..c56991c6d5e4 --- /dev/null +++ b/adaptors/progres.md @@ -0,0 +1,45 @@ +--- +title: ProGres Adaptor +--- + +## About ProGres + +[ProGres](https://www.unhcr.org/) (Protection Registration and Case Management System) is UNHCR's flagship registration and case management system used globally to manage refugee and person of concern data. ProGres v4 is designed to support UNHCR's protection mandate by facilitating the registration, documentation, and case management of refugees, asylum-seekers, internally displaced persons (IDPs), stateless persons, and other persons of concern. + +ProGres is essential for UNHCR operations worldwide, serving as the primary system for managing the protection and assistance of displaced populations. + +## Integration Options + +**REST API via DTP**: ProGres integrations operate through UNHCR's Data Transfer Platform (DTP), a middleware layer that provides secure API access to ProGres data. The DTP acts as a protective gateway, ensuring data security and compliance with UNHCR's strict data protection protocols. Integration requires SSL certificate-based authentication and API tokens for secure communication. + +## Authentication + +ProGres integration requires multiple authentication components for secure access through the DTP: + +```json +{ + "url": "https://endpoint/To/DTP", + "key": "-----BEGIN PRIVATE KEY-----SOMETYPEOFPRIVATEVALUE-----END PRIVATE KEY-----", + "cert": "-----BEGIN CERTIFICATE-----SOMETYPEOFVALUE-----END CERTIFICATE-----", + "token": "[REDACTED]" +} +``` + +**Authentication Components:** +- **URL**: The DTP endpoint URL for your ProGres instance +- **Private Key**: SSL private key for certificate-based authentication +- **Certificate**: SSL certificate for secure communication +- **Token**: API subscription key for request authorization + +All requests must include the subscription key in headers and use SSL certificate authentication for secure data transfer. + +## Helpful Links + +- [OpenFn ProGres Adaptor Configuration](https://docs.openfn.org/adaptors/packages/progres-configuration-schema) +- [OpenFn ProGres Adaptor Docs](https://docs.openfn.org/adaptors/packages/progres-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/rapidpro.md b/adaptors/rapidpro.md index c062ebecabdc..eb3177897c7d 100644 --- a/adaptors/rapidpro.md +++ b/adaptors/rapidpro.md @@ -37,6 +37,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. Sample RapidPro -> DHIS2 sync: [https://github.com/OpenFn/rapidpro-dhis2](https://github.com/OpenFn/rapidpro-dhis2) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/redis.md b/adaptors/redis.md index 7f403cb205d2..0a5e75f1a061 100644 --- a/adaptors/redis.md +++ b/adaptors/redis.md @@ -35,4 +35,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/resourcemap.md b/adaptors/resourcemap.md new file mode 100644 index 000000000000..96844a416895 --- /dev/null +++ b/adaptors/resourcemap.md @@ -0,0 +1,41 @@ +--- +title: ResourceMap Adaptor +--- + +## About ResourceMap + +[ResourceMap](http://resourcemap.instedd.org/) is a free, open-source collaborative mapping platform developed by InSTEDD that helps organizations track their work, resources, and results geographically. It enables teams to collaboratively record, track, and analyze resources using interactive maps with real-time data updates. + +ResourceMap is particularly useful for humanitarian organizations, healthcare systems, supply chain management, and field operations requiring location-based resource tracking and analysis. + +## Integration Options + +**REST API:** ResourceMap offers a comprehensive REST API that enables external applications to interact with its mapping and data collection services. The API supports multiple data formats (JSON, CSV, GeoJSON, RSS) and provides endpoints for managing collections, sites, layers, and user permissions. Refer to the ResourceMap REST API [documentation](https://github.com/instedd/resourcemap/wiki/REST_API) for detailed guidelines on endpoints and payload formats. + +## Authentication + +The ResourceMap adaptor uses HTTP basic authentication or can work with publicly accessible collections: + +```json +{ + "baseUrl": "https://your-resourcemap-instance.com", + "username": "your_username", + "password": "your_password" +} +``` + +For public collections, only the `baseUrl` is required. + + +## Helpful Links + +- [ResourceMap GitHub Repository](https://github.com/instedd/resourcemap) +- [ResourceMap REST API Documentation](https://github.com/instedd/resourcemap/wiki/REST_API) +- [OpenFn ResourceMap Adaptor Configuration](https://docs.openfn.org/adaptors/packages/resourcemap-configuration-schema) +- [OpenFn ResourceMap Adaptor Docs](https://docs.openfn.org/adaptors/packages/resourcemap-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/salesforce.md b/adaptors/salesforce.md index f0b6f48c75f7..35bdc376508a 100644 --- a/adaptors/salesforce.md +++ b/adaptors/salesforce.md @@ -275,3 +275,9 @@ accessing the Salesforce bulk API. - Lwala (CommCare-Salesforce 2-way sync): https://github.com/OpenFn/lwala - GRS CommCare - Salesforce sync: https://github.com/OpenFn/grassroot-soccer - MailChimp-Salesforce sync: https://github.com/OpenFn/gife + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/satusehat.md b/adaptors/satusehat.md index cc837ca3a59e..1db7112a38e4 100644 --- a/adaptors/satusehat.md +++ b/adaptors/satusehat.md @@ -182,3 +182,9 @@ this: "accessToken": "your-access-token" // Don't add accessToken if you're using client secret and client id } ``` + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/senaite.md b/adaptors/senaite.md new file mode 100644 index 000000000000..0fc5b4aa4df7 --- /dev/null +++ b/adaptors/senaite.md @@ -0,0 +1,47 @@ +--- +title: Senaite Adaptor +--- + +## About Senaite + +[Senaite](https://www.senaite.com/) is an Enterprise Open Source Laboratory Information Management System (LIMS) designed for laboratory environments. Built on the Plone CMS, Senaite provides comprehensive sample management, workflow automation, quality control, and reporting capabilities for analytical laboratories. + +Senaite is particularly suited for analytical laboratories requiring ISO/IEC 17025 compliance and serves industries including environmental testing, food safety, pharmaceuticals, and clinical diagnostics. + +## Authentication + +The Senaite adaptor uses HTTP basic authentication with the following configuration: + +```json +{ + "username": "your_senaite_username", + "password": "your_senaite_password", + "baseUrl": "https://your-senaite-instance.com" +} +``` + +## Integration Options + +### HTTP Requests + +Make authenticated HTTP requests to Senaite's REST API: + +```js +request("GET", "catalogs", { + query: { portal_type: "Sample" }, + headers: { "Accept": "application/json" } +}); +``` + + +## Helpful Links + +- [Senaite Documentation](https://www.senaite.com/docs/quickstart) +- [OpenFn Senaite Adaptor Configuration](https://docs.openfn.org/adaptors/packages/senaite-configuration-schema) +- [OpenFn Senaite Adaptor Docs](https://docs.openfn.org/adaptors/packages/senaite-docs) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/sftp.md b/adaptors/sftp.md index ddeb65cb6b31..5ceb48211964 100644 --- a/adaptors/sftp.md +++ b/adaptors/sftp.md @@ -33,7 +33,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. Women for Women International - SFTP -> Salesforce sync: [https://github.com/OpenFn/women-for-women](https://github.com/OpenFn/women-for-women) +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! - - +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/stripe.md b/adaptors/stripe.md index 2ccd3dd6a79d..4fac3611217c 100644 --- a/adaptors/stripe.md +++ b/adaptors/stripe.md @@ -38,3 +38,9 @@ JSON credential type, then your configuration will look something like this: ### Helpful Links 1. [Stripe Documentation](https://docs.stripe.com/get-started) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/surveycto.md b/adaptors/surveycto.md index 5755d6a47c67..c081b064b12e 100644 --- a/adaptors/surveycto.md +++ b/adaptors/surveycto.md @@ -111,3 +111,9 @@ setting controls whether or not users in a given role can use the API to fetch forms and data from the server. [See SurveyCTO docs](https://docs.surveycto.com/04-monitoring-and-management/01-the-basics/00b.managing-user-roles.html) on managing user roles. + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/tableau.md b/adaptors/tableau.md index 24e4e29779c2..6d7a2cca59c8 100644 --- a/adaptors/tableau.md +++ b/adaptors/tableau.md @@ -36,3 +36,9 @@ above use case. ![Tableau Data Flow Visualization](/img/survey_db_tableau.webp) + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/telerivet.md b/adaptors/telerivet.md index 809db1da86ec..aa48502a635d 100644 --- a/adaptors/telerivet.md +++ b/adaptors/telerivet.md @@ -39,5 +39,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/twilio.md b/adaptors/twilio.md index 1246ca391529..b5880ab4b2ff 100644 --- a/adaptors/twilio.md +++ b/adaptors/twilio.md @@ -37,5 +37,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag _Coming soon!_ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/varo.md b/adaptors/varo.md index b495634676ac..41d2f003f165 100644 --- a/adaptors/varo.md +++ b/adaptors/varo.md @@ -28,3 +28,9 @@ connection to the Varo app. See note in above section. - Varo website: https://www.varo-app.org/ - WHO documentation on EMS standard: https://extranet.who.int/prequal/immunization-devices/e006-temperature-monitoring-devices + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/vtiger.md b/adaptors/vtiger.md new file mode 100644 index 000000000000..ff72b55feb9c --- /dev/null +++ b/adaptors/vtiger.md @@ -0,0 +1,52 @@ +--- +title: Vtiger Adaptor +--- + +## About Vtiger + +[Vtiger CRM](https://www.vtiger.com/) is an all-in-one customer relationship management platform that helps businesses manage sales, marketing, and customer support operations in a unified interface. Built around an open-source core, Vtiger provides comprehensive CRM capabilities including lead management, opportunity tracking, customer service, project management, and inventory management. + +## Integration Options + +Vtiger supports integration through its comprehensive REST API and web services, which enable external services like OpenFn to: + +1. **REST API**: Create, read, update, and delete CRM records including leads, contacts, organizations, opportunities, cases, and custom modules. This option is suited for data synchronization, automated data entry, or workflows that need to maintain customer information across multiple systems. See [functions](/adaptors/packages/vtiger-docs) for more on how to use this adaptor to work with the API. + +2. **Web Services**: Access Vtiger's web service APIs for third-party application integration, enabling seamless data exchange between Vtiger and external systems. + +## Authentication + +When integrating with Vtiger via OpenFn, the authentication method requires: +- **Host URL**: Your Vtiger CRM instance URL +- **Username**: Your Vtiger CRM username (email address) +- **Access Token**: Your Vtiger access token for API authentication + +See this adaptor's [Configuration docs](/adaptors/packages/vtiger-configuration-schema) for more on required authentication parameters. + +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: + +```json +{ + "hostUrl": "https://openfunction.od2.vtiger.com", + "username": "test@openfn.org", + "accessToken": "@some()!veryHugeToke" +} +``` + + +### Helpful Links + +2. [Vtiger Documentation](https://www.vtiger.com/docs/) +4. [REST API Manual](https://help.vtiger.com/article/147111249-Rest-API-Manual) +5. [Web Services Integration](http://community.vtiger.com/help/vtigercrm/developers/third-party-app-integration.html) +6. [Free Trial](https://www.vtiger.com/get-started/) + +### Implementation Examples + +_Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/whatsapp.md b/adaptors/whatsapp.md index 934ad5a0a769..6d0d54bba79a 100644 --- a/adaptors/whatsapp.md +++ b/adaptors/whatsapp.md @@ -39,3 +39,9 @@ If working locally or if using a `Raw JSON` credential type in OpenFn, your conf - WhatsApp Business API documentation: https://developers.facebook.com/docs/whatsapp - Cloud API Get Started guide: https://developers.facebook.com/docs/whatsapp/cloud-api/get-started - Webhook payload examples: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/payload-examples + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/wigal-sms.md b/adaptors/wigal-sms.md new file mode 100644 index 000000000000..d4e2342b3c1e --- /dev/null +++ b/adaptors/wigal-sms.md @@ -0,0 +1,53 @@ +--- +title: Wigal SMS Adaptor +--- + +## About Wigal SMS + +[Wigal](https://wigal.com.gh/) is a Ghana-based technology company that provides enterprise-level digital solutions including their flagship SMS platform called [FROG (Free and Reliable Online Gateway)](https://sms.wigal.com.gh/). FROG is Ghana's leading bulk SMS provider, offering the most competitive messaging prices and reliable delivery to all mobile network operators in the country. + + +## Integration Options + +Wigal SMS supports integration through its FROG API, which enables external services like OpenFn to: + +1. **REST API**: Send SMS messages programmatically using the FROG SMS Gateway API. This option is suited for automated notifications, bulk messaging campaigns, or workflows that need to send SMS alerts and communications. See [functions](/adaptors/packages/wigal-sms-docs) for more on how to use this adaptor to work with the API. + +2. **Bulk Messaging**: Send messages to multiple recipients simultaneously, perfect for marketing campaigns, alerts, and mass communications. + +## Authentication + +When integrating with Wigal SMS via OpenFn, the authentication method requires: +- **Username**: Your FROG SMS account username (email address) +- **API Key**: Your FROG SMS API key for authentication +- **Base URL**: The FROG API endpoint (https://frogapi.wigal.com.gh) + +See this adaptor's [Configuration docs](/adaptors/packages/wigal-sms-configuration-schema) for more on required authentication parameters. + +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: + +```json +{ + "username": "test@openfn.org", + "apiKey": "@some(!)apikey", + "baseUrl": "https://frogapi.wigal.com.gh" +} +``` + + +### Helpful Links + +1. [FROG SMS Platform](https://sms.wigal.com.gh/) +2. [Wigal Company Website](https://wigal.com.gh/) +3. [FROG API Documentation](https://frogdocs.wigal.com.gh/) +4. [FROG Registration](https://frog.wigal.com.gh/register) + +### Implementation Examples + +_Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/zata.md b/adaptors/zata.md new file mode 100644 index 000000000000..c8b153cf6ef7 --- /dev/null +++ b/adaptors/zata.md @@ -0,0 +1,57 @@ +--- +title: Zata Adaptor +--- + +## About Zata + +[Zata](https://zata.rw/) is HiQ Africa's flagship retail management and tax compliance platform designed for businesses in East Africa. Zata specializes in automating sales tax reports, managing inventory, and ensuring regulatory compliance with tax authorities like Rwanda Revenue Authority (RRA). The platform offers integrated solutions for retail stock management, EBM (Electronic Billing Machine) invoice automation, and financial services integration. + +## Key Features + +- **Tax Compliance Automation**: Automated sales tax reporting and EBM integration +- **Inventory Management**: Real-time stock tracking, product management, and warehouse operations +- **Transaction Processing**: Sales transaction management with customer and payment tracking +- **Multi-branch Support**: Manage multiple retail locations from a single platform +- **Financial Integration**: Connect with mobile money services (MTN MoMo, Airtel Money) and invoice financing +- **API-First Architecture**: Developer-friendly REST API for seamless integration + +## Integration Options + +Zata supports integration through its REST API, which enables external services like OpenFn to: + +1. **REST API**: Create and manage sales transactions, products, customers, and inventory. This option is suited for e-commerce platforms, POS systems, or ERP integrations that need to sync retail data with Zata's compliance and inventory management features. See [functions](/adaptors/packages/zata-docs) for more on how to use this adaptor to work with the API. + +2. **Real-time Sync**: Synchronize product catalogs, customer data, and transaction records between external systems and Zata's platform for unified retail operations. + +## Authentication + +When integrating with Zata via OpenFn, the primary authentication method supported is: **API Token**. + +See this adaptor's [Configuration docs](/adaptors/packages/zata-configuration-schema) for more on required authentication parameters. + +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: + +```json +{ + "apiToken": "EAAZAq6ZBYUd64BO83b46fn2MdraueL5s9I5IRZCtWUpYsfmEZARN2HDmL8BE5UhFf98EuTnpkhZBWTR9xippoN1a9MzY8Giw3pjSp55YMAF1nowqsy9aLODz48dm8TpXk8ZADUt6qX3vnYJzcn4OH9jrOIiW5ivt3By0beSjbX0E32ZCUMQpS9xRirepvc7qgGKurWQKIcPLPVSGjXQlZCSZBmLdCL8IW07qfjISupZA3HIniORAZDZD", + "baseUrl": "https://example.com", + "apiVersion": "v1" +} +``` + + +### Helpful Links + +1. [Zata Platform](https://zata.rw/) +2. [Zata API Documentation](https://docs.zata.rw/) +5. [Zata Community](https://community.zata.rw/) + +### Implementation Examples + +_Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/adaptors/zoho.md b/adaptors/zoho.md new file mode 100644 index 000000000000..934e705375e9 --- /dev/null +++ b/adaptors/zoho.md @@ -0,0 +1,64 @@ +--- +title: Zoho Adaptor +--- + +## About Zoho + +[Zoho Analytics](https://www.zoho.com/analytics/) (formerly Zoho Reports) is a comprehensive business intelligence and analytics platform that enables organizations to connect, analyze, and visualize data from multiple sources. Zoho Analytics provides self-service BI capabilities with AI-powered insights, allowing users to create reports, dashboards, and perform advanced analytics without extensive technical knowledge. + +## Integration Options + +Zoho Analytics supports integration through its comprehensive REST API, which enables external services like OpenFn to: + +1. **REST API**: Add, update, and retrieve data from Zoho Analytics tables and databases. This option is suited for ETL processes, data synchronization, or workflows that need to populate analytics datasets with external information. See [functions](/adaptors/packages/zoho-docs) for more on how to use this adaptor to work with the API. + +2. **Data Pipeline Integration**: Automate data ingestion from various sources into Zoho Analytics for real-time reporting and dashboard updates. + +## Authentication + +When integrating with Zoho Analytics via OpenFn, the authentication method uses: +- **Account**: Your Zoho Analytics account identifier +- **Auth Token**: Your Zoho authentication token +- **API Version**: The Zoho Analytics API version (v1 or v2, with v2 being recommended) + +See this adaptor's [Configuration docs](/adaptors/packages/zoho-configuration-schema) for more on required authentication parameters. + +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: + +```json +{ + "account": "yourzohoaccount", + "authToken": "secreauthtoken", + "apiVersion": "v2" +} +``` + +## Main Functions + +### addrow + +The primary function of this adaptor is `addrow`, which adds row data to a database table in Zoho Analytics. This function enables you to: + +- Insert new records into existing Zoho Analytics tables +- Populate datasets for reporting and dashboard visualization +- Sync data from external systems into your analytics workspace +- Maintain up-to-date information for business intelligence operations + + +### Helpful Links + +1. [Zoho Analytics Platform](https://www.zoho.com/analytics/) +2. [Zoho Analytics API Documentation](https://www.zoho.com/analytics/api/) +3. [API Specification](https://www.zoho.com/analytics/api/v2/api-specification.html) +4. [Developer Console](https://api-console.zoho.com/) + + +### Implementation Examples + +_Coming soon!_ + +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/package.json b/package.json index f7252ab4bd3b..ddde59b42482 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,8 @@ "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "serve": "docusaurus serve", - "clear": "docusaurus clear" + "clear": "docusaurus clear", + "add-help-sections": "node scripts/add-help-section.js" }, "dependencies": { "@babel/helper-module-transforms": "^7.17.7", diff --git a/scripts/_help-section-template.md b/scripts/_help-section-template.md new file mode 100644 index 000000000000..539b587bd913 --- /dev/null +++ b/scripts/_help-section-template.md @@ -0,0 +1,5 @@ +### I've noticed a problem with this Adaptor, or something is out of date, what can I do? + +Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our [Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for more information on how you can update Adaptors! + +Or, you can always reach out to the Community through our [Community Forum here](https://community.openfn.org/). diff --git a/scripts/add-help-section.js b/scripts/add-help-section.js new file mode 100644 index 000000000000..6b77813f3f44 --- /dev/null +++ b/scripts/add-help-section.js @@ -0,0 +1,58 @@ + +const fs = require('fs'); +const path = require('path'); + + +const TEMPLATE_PATH = path.join(__dirname, '_help-section-template.md'); +const HELP_SECTION = '\n\n' + fs.readFileSync(TEMPLATE_PATH, 'utf8'); + +function addHelpSectionToFile(filePath) { + try { + let content = fs.readFileSync(filePath, 'utf8'); + + + if (content.includes("I've noticed a problem with this Adaptor") || + content.includes("something is out of date, what can I do?")) { + return false; + } + + content = content.trimEnd() + HELP_SECTION; + + fs.writeFileSync(filePath, content); + console.log(`Added help section to: ${path.basename(filePath)}`); + return true; + } catch (error) { + console.error(`Error processing ${filePath}:`, error.message); + return false; + } +} + +function main() { + const adaptorsDir = path.join(__dirname, '../adaptors'); + + if (!fs.existsSync(adaptorsDir)) { + console.error('Adaptors directory not found!'); + process.exit(1); + } + + const files = fs.readdirSync(adaptorsDir); + const markdownFiles = files.filter(file => file.endsWith('.md') && file !== 'intro.mdx'); + + console.log(`Found ${markdownFiles.length} markdown files in adaptors directory`); + + let updated = 0; + for (const file of markdownFiles) { + const filePath = path.join(adaptorsDir, file); + if (addHelpSectionToFile(filePath)) { + updated++; + } + } + + console.log(`\nProcessed ${markdownFiles.length} files, updated ${updated} files`); +} + +if (require.main === module) { + main(); +} + +module.exports = { addHelpSectionToFile, HELP_SECTION };