⌘FARMERS / DEVELOPERS
REST API · v1.1
FARMERS DEVELOPER PLATFORM

Connect. Build.
Grow together.

Secure, versioned access to public Farmers content, with signed events for trusted partner servers. A practical foundation for commerce, marketing and professional integrations.

YOUR APP API client · signed receiver
↕
FARMERS PLATFORM HTTPS · scoped keys · webhooks
↓
PUBLIC COMMUNITY DATA Published Posts & Farms
APIv1Versioned endpoints
CredentialsBearerRevocable application keys
Event signingHMACSHA-256 verification
Privacy boundaryPublicNo private member or payment data
YOUR FIRST LIVE REQUEST

Connect in three steps

Public APIs are currently read-only. Request an admin-issued key; never place the key in JavaScript or a URL.

01

Register

A Farmers administrator registers your application. Save the one-time API token securely on your server.

02

Verify

Call /whoami to confirm the actual authorized application and its public.read permission.

03

Integrate

Read published Posts or Farms, with pagination. Optionally register a signed Post event receiver.

VERIFY CONNECTION
curl --fail-with-body -H "Authorization: Bearer $FARMERS_API_KEY" "https://chatfarm.bluepeople.co.za/wp-json/farmers-platform/v1/whoami"

Use an environment variable for FARMERS_API_KEY on your own trusted server. A successful response confirms the credential and permitted scope.

DOCUMENTED API CONTRACTS

Public data endpoints

JSON over HTTPS. Maximum 25 items per page; no private conversations, support requests or Cloud membership data.

API health ↗
GET/health

Public service identity

Public
GET/whoami

Authenticated application and scopes

Bearer
GET/posts

Published Posts and Seed ideas

Bearer
GET/farms

Published business Farms

Bearer
LIST PUBLISHED POSTS
curl --fail-with-body -H "Authorization: Bearer $FARMERS_API_KEY" "https://chatfarm.bluepeople.co.za/wp-json/farmers-platform/v1/posts?per_page=10&page=1"
OUTBOUND DELIVERY

Signed webhooks

Receive post.published via registered HTTPS endpoint. The exact JSON body is HMAC-SHA256 signed with the one-time webhook secret.

⇢

Queue

Events are scheduled after a real published Post. They must not delay the member's posting action.

⌁

Verify

Validate X-Farmers-Signature over raw bytes. Reject invalid requests and deduplicate events.

↻

Retry

Temporary failures (connection, 429 or 5xx) can be retried by WordPress Cron. A 2xx means receiver accepted delivery.

EXTENSIBLE ECOSYSTEM

Integration roadmap

The first working method is secure REST + signed events. External OAuth and provider-specific adapters are separate certification work.

◈
WordPress / WooCommerce

Public API consumption currently available; future commerce authorization separately

◈
Shopify, CRM & productivity

Provider OAuth, consent, mapping and callback certification pending

◈
Meta, Google Ads, TikTok & Spotify

Provider APIs, policies and scopes must be reviewed

◈
BLUDA Advertising

Publisher delivery and reporting contract pending

◈
BluePay, PayFast, PayPal

Verified payments remain separate from this public-data API

TRUST BY DESIGN

Security and limits

Scopes are restrictive by default. Keys can be revoked; no account impersonation or payment action is permitted through this release.

API authenticationHTTPS · bearer
Permissionpublic.read only
Per-app throttle60 req/min
Private data / CloudNot exposed
Payment operationsNot enabled
Partner OAuthNot connected

For production integrations, retain server-side secrets, use exact authorization callbacks and verify all provider signatures. The public document describes available contracts, not a universal no-setup adapter.

Scroll to Top