Understanding Core Services APIs 🌾

Welcome to the comprehensive API reference for the Cropwise Core Services. This documentation covers all the essential APIs you need to integrate with our platform for digital agriculture applications.

Introduction

The Cropwise Core Services offers common functionality for digital agriculture apps including OAuth-based Single Sign-On, properties, fields, and more. The API is built on HTTP and is RESTful with predictable resource URLs, appropriate HTTP response codes, and JSON request/response bodies.

Interactive API Documentation

For detailed information about all available endpoints, request/response formats, and authentication requirements, please visit our interactive API documentation.

Platform Architecture

The Cropwise Core Services is built around a hierarchical structure that mirrors real-world agricultural organization:

🏢 Workspace
└── 🏛️ Organization  
    └── 🏘️ Property
        └── 🌾 Field

Core API Sections

Organizations API

The Organizations API allows you to create and manage organizations within your workspace. Organizations represent business entities or farming operations.

View Organizations API Documentation →

Properties API

The Properties API enables you to manage farming locations and land parcels. Properties are containers for fields and include geographical information.

View Properties API Documentation →

Fields API

The Fields API provides functionality for managing individual cultivation areas. Fields are the basic units for agricultural operations.

View Fields API Documentation →

Error Handling

Error Response Format

{
  "timestamp": "2024-01-15T10:30:00Z",
  "status": 404,
  "error": "Not Found", 
  "code": "EORG011",
  "message": "Organization does not exist",
  "path": "/v2/orgs/123e4567-e89b-12d3-a456-426614174000",
  "errors": [
    {
      "field": "id",
      "reason": "Organization with ID 123e4567-e89b-12d3-a456-426614174000 not found"
    }
  ]
}

Error Code Format

All error messages are mapped with structured error codes in the format: E{3 character context}{3 digit index}

Common Error Codes

HTTP Status Codes

Data Formats

Standard Formats

• Request/Response: JSON format
• Geographic Data: GeoJSON for boundaries and coordinates
• Dates: ISO 8601 format for date-times (e.g., "2024-01-15T16:45:00Z")
• IDs: UUID format (e.g., "987e6543-e89b-12d3-a456-426614174003")

Geographic Data Standards

• Format: GeoJSON (RFC 7946)
• Datum: WGS84
• Precision: Decimal degrees
• Order: [longitude, latitude] (GeoJSON standard)

Quick Start Examples

For complete request/response examples and interactive testing, visit our comprehensive OpenAPI documentation:

📚 Interactive API Documentation → - Test all endpoints with live examples

Getting Started Workflow

1. Create Organization → - Set up your farming business entity
2. Create Property → - Add farming locations
3. Create Field → - Define cultivation areas

Each endpoint includes:

• Complete request/response schemas
• Required and optional parameters
• Authentication requirements
• Error codes and responses
• Interactive examples you can test directly

Rate Limiting

API requests are subject to rate limiting to ensure fair usage and system stability.

Response Headers

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1640995200

Support Resources

Documentation

• Getting Started Guide →
• Best Practices →

Support

• 📧 Contact Syngenta Digital for API access and support
• 📖 OpenAPI Specification: Download

Ready to start building? Begin with creating your first organization →, explore property management →, or manage fields →.