Cropwise Integration Onboarding Guide
The Cropwise integration enables the automated import of data from a customer’s Cropwise environment into the platform.
Once configured and validated, the import runs automatically on a scheduled basis and requires minimal ongoing maintenance. The onboarding process includes secure credential transfer, configuration, a non-production validation import, customer review, and production activation.
What is coveredNot all platform data has a counterpart in Cropwise. The current Cropwise import covers the following areas:
| Cropwise enterprise or data area | Sandy object or section |
|---|---|
| All | Farm |
| Farm Enterprise: Arable and Horticulture, Perennials, Permanent Grassland, Woodland | Field |
| Manufactured Fertiliser | Manufactured Fertiliser |
| Organic Fertiliser | Organic Fertiliser |
| Crop Protection: Arable and Horticulture | Crop Protection |
| Cropping | Cropping |
| Operations | Operations |
| Fuel – Machinery | Fuel – Machinery |
| Transport | Energy Data |
Anything not listed above should be treated as outside the scope of the current Cropwise import implementation.
Examples of areas that are not currently covered include:
- Soil Testing
- Natural Capital Features
- Residue Management
- Fuel Dry & Storage
Data-point limitations
A covered section may still contain individual data points that are either:
- Imported with a default value
- Not imported at all
For example, all Cropping data is imported from Cropwise with Crop Variety set to NA.
For the complete field-level mapping and data-point handling rules, refer to the Cropwise Integration Specification.
PrerequisitesBefore the integration can be configured, the customer must provide a valid Cropwise API token. Cropwise documentation refers to this credential as the User API Token.
How to obtain the API token
Follow the authentication guidance in the Cropwise API documentation:
Cropwise API authentication documentation
Secure token transferThe API token is a sensitive credential and must be transferred using an approved secure method.
Preferred options include:
- Share the token through a password-management solution such as 1Password, or another approved secure secrets-management or password-sharing platform.
- Send the token in an encrypted document or password-protected archive.
- If an encrypted document or archive is used, share the password through a separate communication channel, such as SMS, a phone call, or an approved messaging application.
Do not send API credentials through unencrypted email.
Initial validation is required
Cropwise data can be structured differently between customers. An initial validation phase is therefore strongly recommended before the integration is enabled in production.
Validation confirms that the imported data accurately reflects the customer’s business data and identifies any additional mapping or configuration requirements early in the onboarding process.
Data validationAfter the initial import is complete, review the imported data with the customer.
Confirm that:
- All expected organisations have been imported.
- Field boundaries and related data are correct.
- Crops, seasons, and other business data are represented accurately.
- No additional mapping or configuration changes are required.
Record and assess any feedback identified during this review before enabling the production import.
Additional requirements and changes
If validation identifies a requirement for additional mapping or integration changes, the request must be reviewed before implementation.
Changes to the integration are subject to review and approval by the Product and Engineering leads before proceeding to production.
Automated import scheduleOnce the integration has been configured and successfully validated:
- The import runs once per week by default.
- The import is scheduled to run overnight.
- The schedule can be adjusted when required to meet business needs.
Import behavior is also based on the outcome of the previous run. The integration attempts to import the complete Cropwise dataset unless the previous import was completely error-free, with no record-level errors.
Monitoring importsImport results and processing errors can be reviewed through the Excel Import interface within the application.
The interface provides visibility into:
- Import status
- Successfully imported records
- Validation errors, if any
- Processing logs
Review import results after the initial import and as part of ongoing support when errors or unexpected data are reported.
Onboarding checklist
Use this checklist to confirm that onboarding is complete:
- [ ] The customer provided a valid Cropwise User API Token.
- [ ] The token was transferred using an approved secure method.
- [ ] The Cropwise API token was configured in the application.
- [ ] The required organisation or organisations were configured.
- [ ] An initial import was completed in a non-production environment.
- [ ] Imported organisations, field boundaries, crops, seasons, and related data were validated with the customer.
- [ ] Any additional mapping or configuration requirements were reviewed and approved.
- [ ] The automated production import was enabled.
- [ ] Review import results and processing errors.
The Cropwise integration onboarding process consists of:
- Provide the Cropwise API token using a secure transfer method.
- Configure the API connection and organisation or organisations.
- Perform an initial import in a non-production environment.
- Validate the imported data with the customer.
- Address any required configuration or mapping changes.
- Enable the automated scheduled import.
- Monitor import results and processing errors through the Excel Import interface.
Following this process helps ensure a successful integration and provides an opportunity to verify that imported Cropwise data accurately reflects the customer’s environment before production activation.