Prodaksha Developers

Welcome

Prodaksha runs factories: coffee and tea factories, mills, dairies, juice plants, bakeries, soap makers, metal shops and more, in Kenya, Uganda, Tanzania and Rwanda. It records what comes in, what is made, how it is checked, what is sold and what is paid.

These pages are for developers of other systems that work with those factories: a farmer society or cooperative system (like FPOBox), a buyer's or exporter's system, an accounting or ERP system, sensors in a cold store, or your own dashboard.

What you can do

You want to How
Send raw material to a factory (a society's or supplier's delivery) POST /api/v1/consignments (Connecting a supplier or society system)
Know when it was weighed in, processed, charged, sold and paid Webhooks: Prodaksha calls your address as each step happens (Webhooks)
Approve or dispute a weight difference or a processing statement POST /api/v1/consignments/{id}/variance/{decision}, POST /api/v1/statements/{id}/approve or /dispute
Read the factory's items, grades, units and purchase prices GET /api/v1/items, GET /api/v1/price-lists
Trace a lot back to its delivery and forward to its buyers GET /api/v1/lots/{lot_no}/trace
Read invoices and payments made to your members or suppliers GET /api/v1/invoices, GET /api/v1/payments
Send cold-store temperatures from a probe POST /api/v1/temperature-readings

Two ways to talk

  1. You call Prodaksha (REST API, JSON over HTTPS) at https://prodaksha.com/api/v1, with a token that belongs to one factory.
  2. Prodaksha calls you (webhooks): a signed POST to your address when something happens at the factory.

Most integrations use both. FPOBox also lets the factory pull from it every 15 minutes, so nothing is lost if a call fails; see FPOBox.

How the pages are organised

Page Read it when
Quick start You want a first call working in ten minutes
Key ideas You need the words: consignment, intake, lot, run, grade, toll, statement, proceeds
Tokens, errors and limits Before you write production code
Webhooks You want events pushed to you
Connecting a supplier or society system Your system sends goods to factories (the main integration)
FPOBox You work on FPOBox, or a system built the same way
Other integrations Buyers, accounting, sensors, dashboards
Testing and going live Before you switch on for a real factory
Troubleshooting Something is refused or missing
Value chains You want to know what a coffee mill, tea factory or juice plant receives and makes, with example messages
API reference Every endpoint, field and answer

The machine-readable specification is at /api/v1/openapi.yaml and /api/v1/openapi.json. Import it into Postman, Insomnia or a code generator.

Promises

  • Version 1 only grows. New fields and events may appear, so ignore what you do not know. Nothing is renamed or removed; a breaking change would be a new /api/v2.
  • One factory per token. A token can never see another factory's data.
  • Every write can be retried safely with an Idempotency-Key (Tokens, errors and limits).
  • Every webhook is signed, and each event has an id, so you can check it and ignore repeats.