Skip to main content
Orchard offers four ways to add the investment flow to your site. They differ in how you install the SDK (a CDN script tag or an npm package) and how the flow appears to your users (a popup you open from a button, an inline embed, or a modal).

What every method needs

All four methods use the same credentials:
  • API key: your Orchard public key (starts with pk_), sent in the X-Orchard-Key header.
  • API URL: the Orchard embed API, for example https://core.orchard.africa/api/v1/embed.
  • Session token: created by calling POST {apiUrl}/session with your API key. See Authentication.

CDN Script

Add one script tag and open the flow from a button.

Inline Embed

Install from npm and embed the flow in your page.

Modal Embed

Install from npm and show the flow in a dialog.

Custom Branding

Show the flow with your brand name and color.