Overview: AgLogic™ API
The resource documentation will provide details for each of the web services available with AgLogic™. The details will describe the URL pattern, the HTTP method, the data format, and response codes. For all of the web services, data will be encrypted with SSL and Basic Authentication will be used to provide security at the Organization level.
In the documentation, you will see several identifiers (IDs) referenced: sourceId, clientId, farmId, fieldId, and orderId. All of these IDs will be controlled by the BMS. They must be unique within their organization.
Some entities are hierarchical in nature, like fields are part of a farm. In those cases, the URL will look like this:
The AgLogic™ application is a web application that is designed to help an Agronomics Provider schedule and manage the delivery and application of Agronomics products. AgLogic is designed to work with an Agronomics Providers existing Business Management System (BMS). Since it works with and does not replace a BMS, AgLogic needs mechanisms for importing data from a BMS, and exporting data to a BMS. Furthermore, AgLogic is agnostic as to the types of BMS that it will integrate with. Any system that can provide data in the format that AgLogic expects can integrate with AgLogic.
AgLogic provides two types of mechanisms for integration: Web Services and File Import. The Web Services mechanism is the preferred integration mechanism since it provides a “hands off” machine to machine mechanism of exchanging data. The file import is provided for the BMS that do not have the means for a web service exchange, but do provide some sort of file export.
Integration Option: Web Services
AgLogic™ provides for two mechanisms of integration: web services and file imports. The web services provide for direct machine-to-machine interaction, and it is the preferred mechanism. The file import mechanism is provided for those situations where the web services implementation is not technically feasible.
File imports are not yet defined.
Web Services are a mechanism for machine to machine communication, usually implemented on top of the HTTP protocol, and utilizing the World Wide Web.
There are two main architectures of web services being implemented today: RPC/SOAP web services, and RESTful web services.
This document will not debate the merits of either approach.
John Deere Agri Services has adopted REST as its standard approach to web services and AgLogic will be using REST for its integration.
For more information about RESTful web services, see
“RESTful Web Services”, by Richardson and Ruby.
The three main REST concepts that we will be concerned about in this document are: Resource Address, Resource Representation, and Resource Action.