Skip to content

Commit 25f1dac

Browse files
Adaptor overview pages (#638)
* Create odoo.md * Update mailchimp.md * Create hubtel.md * Update odoo.md --------- Co-authored-by: Aleksa Krolls <aleksa@openfn.org>
1 parent bb84e60 commit 25f1dac

File tree

3 files changed

+92
-1
lines changed

3 files changed

+92
-1
lines changed

adaptors/hubtel.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Hubtel Adaptor
3+
---
4+
5+
## About Hubtel
6+
7+
[Hubtel](https://www.hubtel.com/) is a payment, messaging, and e-commerce platform that enables businesses to send SMS messages, process mobile money transactions, and manage digital commerce operations. Hubtel supports API integrations to facilitate seamless business automation.
8+
9+
## Integration Options
10+
11+
Hubtel supports two primary integration options with OpenFn:
12+
13+
**1. Rest API:** Hubtel 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 Hubtel. Refer to the Hubtel REST API [documentation](https://api.hubtel.com/) for detailed guidelines on endpoints and payload formats.
14+
15+
**2. Webhook:** Webhook or Data Forwarding to push data from Hubtel to external systems ([see docs](https://developers.hubtel.com/docs/webhooks)). This option is suited for real-time, event-based data integration.
16+
17+
## Authentication
18+
1. See [Hubtel docs](https://developers.hubtel.com/docs/authentication) for the latest on supported authentication methods.
19+
2. When integrating with Hubtel via OpenFn, authentication via **API Key** is supported.
20+
3. See this adaptor's [Configuration docs](/adaptors/packages/hubtel-configuration-schema) for more on the required authentication parameters.
21+
22+
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
23+
24+
```
25+
{
26+
"baseUrl": "https://example.com",
27+
"clientId": "abc123def",
28+
"clientSecret": "ghi456jkl"
29+
}
30+
```
31+
32+
### Helpful Links
33+
34+
1. [Hubtel Developer Portal](https://developers.hubtel.com/)
35+
2. [API Reference](https://developers.hubtel.com/docs/)
36+
3. [Webhook Setup Guide](https://developers.hubtel.com/docs/webhooks)
37+
38+
39+
### Implementation Examples
40+
41+
_Coming soon!_
42+
43+
44+
45+

adaptors/mailchimp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: MailChimp Adaptor
1010

1111
Mailchimp supports two primary integration options:
1212

13-
**1. Rest API:** Mailchimp 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 OpenMRS. Refer to the Mailchimp REST API [documentation](https://mailchimp.com/developer/marketing/api/) for detailed guidelines on endpoints and payload formats.
13+
**1. Rest API:** Mailchimp 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 Mailchimp. Refer to the Mailchimp REST API [documentation](https://mailchimp.com/developer/marketing/api/) for detailed guidelines on endpoints and payload formats.
1414

1515
**2. Webhook:** Webhook or Data Forwarding to push data from MailChimp to external systems ([see docs](https://mailchimp.com/developer/transactional/docs/webhooks/)). This option is suited for real-time, event-based data integration.
1616

adaptors/odoo.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Odoo Adaptor
3+
---
4+
5+
## About Odoo
6+
7+
[Odoo](https://odoo.com/) is a marketing automation platform that allows businesses to design, send, and manage email campaigns. It also provides tools for audience management, analytics, and integrations with other platforms to support marketing efforts.
8+
9+
## Integration Options
10+
11+
Odoo supports two primary integration options with OpenFn:
12+
13+
**1. Direct DB Connection:** This is what _this_ adaptor supports to directly connect to your Odoo database.
14+
15+
**2. Rest API:** Odoo offers a REST API that enables external applications to interact with its services, but this is a *paid option/may require an additional plugin*. This option is ideal for applications requiring scheduled or bulk synchronization with Odoo. Refer to the Odoo REST API [documentation](https://www.odoo.com/documentation/16.0/developer/api/external_api.html) for detailed guidelines on endpoints and payload formats.
16+
17+
**3. Webhook:** Webhook or Data Forwarding to push data from Odoo to external systems ([see docs](https://www.odoo.com/documentation/16.0/developer/reference/webhooks.html)). This option is suited for real-time, event-based data integration.
18+
19+
## Authentication
20+
1. See [Odoo docs](https://www.odoo.com/documentation/16.0/developer/misc/api/odoo.html) for the latest on supported authentication methods.
21+
2. When integrating with Odoo via OpenFn, authentication via **User Credentials** is supported.
22+
3. See this adaptor's [Configuration docs](/adaptors/packages/odoo-configuration-schema) for more on the required authentication parameters.
23+
24+
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:
25+
26+
```
27+
{
28+
"password": "@some(!)Str0ngp4ss0w0rd",
29+
"username": "test@openfn.org",
30+
"database": "devel",
31+
"baseUrl": "https://dev.newlogic-demo.com"
32+
}
33+
```
34+
35+
### Helpful Links
36+
1. [Odoo Developer Portal](https://www.odoo.com/documentation)
37+
2. [API Reference](https://www.odoo.com/documentation/16.0/developer/api/external_api.html)
38+
3. [Webhook Setup Guide](https://www.odoo.com/documentation/16.0/developer/reference/webhooks.html)
39+
40+
### Implementation Examples
41+
42+
_Coming soon!_
43+
44+
45+
46+

0 commit comments

Comments
 (0)