DataPlatform API (1.0)

Email: support@agrigate.co.nz URL: www.agrigate.co.nz

Agrigate's Data API provides access to agriculture data across integrated industry partners.

Authentication

OAuth2

We use OAuth2 for authentication, so you will need a valid client id and client secret to get an access token.

The authentication endpoint is

https://auth.api-dev.agrigate.co.nz?grant=client_credentias&client_id=<YOUR_CLIENT_ID>&secret
=<YOUR_CLIENT_SECRET>

Once you get you access token, you will need to send it in the Authorization header as follows:

Authorization: Bearer <YOUR_TOKEN>

Security scheme type:	https

API Resources

Integrations

  /integrations

Authorizations:

OAuth2 (integrations/readintegrations/list)

query Parameters

limit	integer The maximum amount of results returned. (Default 10)
next	string Start results from this last evaluated key.
type	string Request results of a specific type.

Responses

200

Successful Integration endpoint data response.

404

Agrigate integrations not found.

get /integrations

Production server

https://api.agrigate-data.io/integrations

User Acceptance Testing server

https://api.uat.data.agrigate-dev.io/integrations

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "integrations",
  - "id": "361956ad5c8d43aab906fbb1b0668458cf79c3a1025e437b66b7851de2002f00",
  - "attributes":
    {
    "type": "dairy-diary",
    "customer_id": "183792",
    "target":
    [
    "73377"
    ],
    "updated_at": "2019-08-12T11:07:50.923584+00:00"
    }
  }
],
"links":
{
- "next": "http://example.com"
}

}

Health Conditions

  /animal-health

Authorizations:

OAuth2 (animal-health/readanimal-health/list)

query Parameters

customer_id required	string Unique ID for data partner customer.
target required	string Request mapped animal health records by data partner resource.
deleted	boolean Specifies whether deleted records will be included in the results (Default false)
limit	integer The maximum amount of results returned. (Default 10)
modified_since	integer Request records modified by the data provider since this UNIX timestamp.
next	string Start results from this last evaluated key.

Responses

200

Successful Animal health endpoint data response.

404

Agrigate integration not found.

get /animal-health

Production server

https://api.agrigate-data.io/animal-health

User Acceptance Testing server

https://api.uat.data.agrigate-dev.io/animal-health

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "animal-health-record",
  - "id": "3aad21c97d917d74b78fec68d8713cebe62ada732a7a73a9aeb1d2719e930660",
  - "attributes":
    {
    "updated_at": "2019-08-08T13:11:12.291310+00:00",
    "farm_event_time": "2016-11-24T11:00:00+00:00",
    "provider_event_time": "2016-11-25T02:33:09.387000+00:00",
    "condition":
    {
    "code": "NC",
    "description": "Non Cycling/Anoestrus",
    "category_code": "REPR",
    "category_description": "REPRODUCTIVE DISORDER"
    },
    "product":
    {
    "code": 1234,
    "description": "Bovaclox Dry Cow",
    "category_code": "DCT",
    "category_description": "DRY COW THERAPIES"
    },
    "herd_treatment": false,
    "dry_cow": false,
    "dosage_count": 2,
    "dosage_interval":
    {
    "value": 48,
    "unit": "Hours"
    },
    "dosages":
    [
    {
    "value": 0,
    "unit": "string",
    "date": "2019-09-04T03:31:02Z",
    "number": 0,
    "administered_by": "John Doe"
    }
    ],
    "withholding_for_milk":
    {
    "value": 120,
    "unit": "Hours"
    },
    "withholding_for_meat":
    {
    "value": 130,
    "unit": "Hours"
    },
    "return_to_vat":
    {
    "date": "2019-04-08T12:00:00.000000+00:00",
    "meridiem": "AM"
    },
    "affected_quarters":
    {
    "front_left": true,
    "front_right": true,
    "rear_left": true,
    "rear_right": true
    },
    "provider": "LIC MINDA"
    },
  - "relationships":
    {
    "animals":
    {
    "data":
    [
    {
    "type": "animal",
    "id": "19858f8537bf93f1fb8b86c711c30a0e46691cec71477751bc0d88e2cfb4053x"
    }
    ]
    }
    }
  }
],
"included":
[
- {
  - "type": "animals",
  - "id": "19858f8537bf93f1fb8b86c711c30a0e46691cec71477751bc0d88e2cfb4053m",
  - "attributes":
    {
    "updated_at": null,
    "group_id": 12345,
    "birth_id":
    {
    "prefix": "KRK",
    "year": 2013,
    "sequence": 14
    },
    "eid": "982 123463518570",
    "management_number": 200,
    "provider": "LIC MINDA"
    }
  }
],
"links":
{
- "next": "http://example.com"
}

}

Milk Production Quality

  /milk-production-quality

Authorizations:

OAuth2 (milk-production-quality/readmilk-production-quality/list)

query Parameters

customer_id required	string Unique ID for data partner customer.
target required	string Request mapped animal health records by data partner resource.
limit	integer The maximum amount of results returned. (Default 10)
modified_since	integer Request records modified by the data provider since this UNIX timestamp.
next	string Start results from this last evaluated key.

Responses

200

Successful Milk production quality endpoint data response.

404

Agrigate integration not found, no available assets found or invalid scope provided.

get /milk-production-quality

Production server

https://api.agrigate-data.io/milk-production-quality

User Acceptance Testing server

https://api.uat.data.agrigate-dev.io/milk-production-quality

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "string",
  - "id": "string",
  - "attributes":
    {
    "date_of_pickup_event": "2019-09-04T03:31:02Z",
    "updated_at": "2019-09-04T03:31:02Z",
    "deleted_at": "2019-09-04T03:31:02Z",
    "pickup_number": 0,
    "production_days": 0,
    "vat_number": 0,
    "urea":
    {
    "value": 0,
    "unit": "string"
    },
    "temperature":
    {
    "value": 0,
    "unit": "string"
    },
    "fat":
    {
    "value": 0,
    "unit": "string"
    },
    "protein":
    {
    "value": 0,
    "unit": "string"
    },
    "milk_solids":
    {
    "value": 0,
    "unit": "string"
    },
    "volume":
    {
    "value": 0,
    "unit": "string"
    },
    "scc":
    {
    "value": 0,
    "unit": "string"
    },
    "fei":
    {
    "value": 0,
    "unit": "string"
    }
    }
  }
],
"links":
{
- "next": "http://example.com"
}

}