Leaf connects to Agvance using an API key combined with username/password credentials. Once connected, Leaf syncs growers, farms, and fields from the Agvance system.
Prerequisites
- Access to an Agvance instance with API access enabled.
- Your
apiKey from Agvance.
- The
username, password, and databaseId for the target Agvance database.
- Optional:
clientEnvironment if you need to override the default environment.
Setup steps
POST the credentials to Leaf:
curl -X POST \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"apiKey": "your-api-key",
"clientEnvironment": "PRODUCTION",
"databaseId": "target-database-id",
"password": "your-password",
"username": "your-username"
}' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/agvance-credentials'
Credentials schema
Create request body:
| Field | Type | Required | Description |
|---|
apiKey | string | Yes | Your Agvance API key |
clientEnvironment | string | No | STAGE or PRODUCTION. Defaults to STAGE if omitted. |
databaseId | string | Yes | The target Agvance database ID |
username | string | Yes | Agvance username |
password | string | Yes | Agvance password |
{
"id": "uuid",
"status": "str",
"createdTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"clientEnvironment": "PRODUCTION",
"username": "str",
"password": "str",
"databaseId": "str",
"sessionId": "str",
"apiKey": "str"
}
sessionId after successful authentication. If you omit clientEnvironment, Leaf defaults it to STAGE.
Confirm the credentials are attached
Check the stored credentials for the Leaf user:
curl "https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/agvance-credentials" \
-H "Authorization: Bearer YOUR_TOKEN"
sessionId.
Endpoints
Base URL: https://api.withleaf.io/services/usermanagement/api
| Action | Method | Path |
|---|
| Get credentials | GET | /users/{leafUserId}/agvance-credentials |
| Create credentials | POST | /users/{leafUserId}/agvance-credentials |
| Delete credentials | DELETE | /users/{leafUserId}/agvance-credentials |
| Get credential events | GET | /users/{leafUserId}/agvance-credentials/events |
Troubleshooting
Use the events endpoint to inspect credential health:
curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/agvance-credentials/events'
Event logs are retained for 30 days. Once the credential is deleted or disassociated from the Leaf user, the logs are no longer available.
- Invalid credentials: If the password changes in Agvance, delete and recreate the credentials with the new password.
- Wrong database ID: Verify the
databaseId matches the target Agvance database.
- STAGE vs. PRODUCTION mismatch: If you set
clientEnvironment explicitly, make sure it matches the Agvance instance you’re connecting to.
What to do next
