Developer Quickstart
Integrate with the Village API to unlock the power of Village
Last updated
Was this helpful?
Integrate with the Village API to unlock the power of Village
Last updated
Was this helpful?
Enable Village to execute Rules in real-time, you need to connect your system to Village through Village's API.
Prerequisites:
Note on API Asynchronous Responses:
The real-time response code you do receive from a Village POST API request represents whether or not your request has been added to our asynchronous processing queue, not whether the POST request and any downstream Programs & Rules were fully process without errors.
Once you've created a network and have an administrator account, you can generate an API key and begin the integration process.
From the Side Menu of your Network Admin view, navigate to "Manage Network" --> "API Tokens & Documentation."
Caution: Village API keys allows privileged access to your Network and any funds you have allocated to your Network's connected bank account and treasury. Make sure you keep it secure.
Caution: The key will be shown only once and cannot be shown again.
Click "Generate New Key", fill out the fields below, and click "Generate":
The key will be shown only once and cannot be shown again, so be sure to transfer it to a secure location. In the event your keys are lost or stolen, they should be immediately deleted and replaced with new keys.
An Admin Account ()
A Network ()
Due to our system's asynchronous processing architecture and cryptographically verifiable ledger, our POST APIs utilize an and a to display errors and other information related to API requests.
To view downstream processing errors and other information related to your POST requests, use the and a .
Connect your data with the
Check out the for general Authentication & Response references
Connect your user signup flow to Village using the
