> For the complete documentation index, see [llms.txt](https://village-labs.gitbook.io/coworker-product-and-developer-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://village-labs.gitbook.io/coworker-product-and-developer-docs/legacy-developer-docs/developer-quickstart.md).

# Developer Quickstart

Integrate with the Village API to unlock the power of Village

## Note: These docs are still actively supported, but are considered Legacy as most API connections are no longer required except in edge use cases to take advantage of Village Labs.

## You are Here :point\_down:

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FBmMfawLdvB5Q7gyXFJcd%2FScreenshot%202023-06-08%20at%203.57.54%20PM.png?alt=media&amp;token=ce501a9b-88f9-4d14-b998-6ab103008ea4" alt=""><figcaption><p>Connecting to Village</p></figcaption></figure>

{% hint style="info" %}
**Jump to API Docs:**&#x20;

* [Postman Collection ->](https://www.postman.com/planetary-meadow-916406/workspace/village-api-development/collection/23201170-c8c93cfd-7824-4621-977f-192d91741e85?action=share\&source=collection_link)
* [Village API Intro ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction.md)
* [Activity API ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/activity-api.md)
* [User Status API ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/user-status-api.md)
* [Segments API -> ](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/segments-api.md)
* [Redemption API ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/redemption-api.md)&#x20;
* [Master Award Controls (Issue, Burn, Exchange, Transfer) -> ](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/master-award-controls.md)
* [Connections (Referrals) API ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/connections-referrals-apis.md)
* [GET APIs ->](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/get-apis.md)

**Looking for something else?**

* [Learn about the product with Admin Quickstart ->](/coworker-product-and-developer-docs/legacy-knowledge-base/admin-quickstart.md)&#x20;
* [Low and No-Code Solutions ](/coworker-product-and-developer-docs/no-and-low-code-solutions/no-and-low-code-solutions.md)[->](/coworker-product-and-developer-docs/no-and-low-code-solutions/no-and-low-code-solutions.md)
  {% endhint %}

## Connecting to Village

Enable Village to execute Rules in real-time, you need to connect your system to Village through Village's API.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FHRBgVhykjD7ZFUOAFOXR%2Fimage.png?alt=media&amp;token=7471cad6-5e3b-47e4-9e94-c7ba370bc601" alt=""><figcaption><p>The Village System</p></figcaption></figure>

## Generate an API Key <a href="#generate-api-key" id="generate-api-key"></a>

{% hint style="warning" %}
**Prerequisites:** &#x20;

1. An Admin Account ([Invite Users & Admins ->](/coworker-product-and-developer-docs/legacy-knowledge-base/admin-quickstart.md#invite-users-and-admins))
2. A Network ([Create a Network ->](/coworker-product-and-developer-docs/legacy-knowledge-base/admin-quickstart.md#create-a-network))
   {% endhint %}

{% hint style="warning" %}
**Note on API Asynchronous Responses:**&#x20;

Due to our system's asynchronous processing architecture and cryptographically verifiable ledger, our POST APIs utilize an [API Results Table](#api-results-table) and a [GET Results API](#get-results-api) to display errors and other information related to API requests.

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.&#x20;

To view downstream processing errors and other information related to your POST requests, use the [API Results Table](#api-results-table) and a [GET Results API](#get-results-api).
{% endhint %}

Once you've created a network and have an administrator account, you can generate an API key and begin the integration process.&#x20;

From the Side Menu of your Network Admin view, navigate to "Manage Network" --> "API Tokens & Documentation."&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2F3lgoYDX94iZjl9hYCTyL%2Fimage.png?alt=media&amp;token=0e99529b-42f6-46c1-8f8b-5a922125aac2" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**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.
{% endhint %}

{% hint style="danger" %}
**Caution:** The key will be shown only once and cannot be shown again.
{% endhint %}

Click "Generate New Key", fill out the fields below, and click "Generate":

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2Fjv4wHbyTXTtrKNKYc9am%2Fimage.png?alt=media&amp;token=52e5064a-358c-421e-8c68-a4e81203503a" alt="" width="375"><figcaption></figcaption></figure>

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.&#x20;

## **Recommended Quickstart Next Steps:**

{% hint style="success" %}

1. Connect your data with the [**Activity API ->** ](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/activity-api.md)
2. Check out the [**Village API Intro ->**](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction.md) for general Authentication & Response references
3. Connect your user signup flow to Village using the [**Use Status API ->**](/coworker-product-and-developer-docs/legacy-developer-docs/village-apis-introduction/user-status-api.md)
   {% endhint %}

{% hint style="info" %}
[**Is this page helpful? Give us feedback on our docs ->**](/coworker-product-and-developer-docs/feedback/village-docs-feedback-form.md) [ ](/coworker-product-and-developer-docs/feedback/village-docs-feedback-form.md)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://village-labs.gitbook.io/coworker-product-and-developer-docs/legacy-developer-docs/developer-quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.