This API is provided to allow Airscout partners to retrieve aerial imagery with the intention of being used in our partners own applications.
\nIn order to use this API a consuming partner needs to request an “App User Key” which is unique to the consumer of the information and can be throttled or revoked if abuse is detected. This “App User Key” is an unsigned UUID and should be protected and not shared. The API is intended to be easy to use, not complicated, but abuse can be detected and will not be tolerated. This “App User Key” must be included in the header of every request as “appUserKey”.
\nThe second piece of information needed to use the API is an “External Partner ID.” This ID represents a system external to Airscout who will have their own ID set for fields and imagery. The “External Partner ID” is unique to a system. This is the key that will allow mapping from an external parter’s system to Airscout’s. If you are just consuming imagery and not trying to map IDs from an external partner’s system and will use Airscout Field IDs for all requests you can use “1″ as the External Partner ID when creating requests.
\nThis API does not require maintaining Airscout Field IDs in an external partners database but does require mapping field IDs from an external parter’s ID set to Airscout previous to retrieving field image meta data or field image resources. Fields are mapped from an Airscout field ID to a given external partner’s field ID by the provided “External Partner ID” which represents the external partner’s ID set. The mapping can either happen manually by updating the external parter row mapping table in the Hierarchy Management web app or via the provided API defined below. To use the API a user can request an Airscout field ID using the fields center and then post a response back to the API using that Airscout field ID and the equivalent External Partner’s field ID.
\nA single “Field Image” is considered and sometimes referred to as a single “Asset” and represents a single image taken by a pilot. That image can be requested in many forms and thus a “Field Image” is not a single file but rather meta data about a single image at a point in time that was taken and potentially further analyzed or processed.
\nA “Requested Resource” is a single file which could be a scaled version of the original field image taken by a Pilot, a geo-referenced image in KML format or one of several other formats.
\nA single field image can actually have different versions depending on how the image was processed. For instance during image processing an ADVI or Thermal image can be rendered so that the image displays in Max Contrast which is best for identifying field variability or Normalized which an image will be optimized for comparing images in a series over the season.
\nHere are the “Asset Versions” that can be requested and their correspond “Asset Version IDs” that should be used in the follow API.
\n0 – Root – The base asset version used for visual images or other asset types where having various asset versions might not make sense
\n1 – Normalized – The processed version of an asset that is optimized for comparing images in series over a season
\n2 – Max Contrast – The processed version of an asset that is optimized for bringing out variability in image data
\nA given “Asset Version” can be requested in various formats or “resource variations.” For instance an image could be requested as a plain flat image, as a raster data set, a georeferenced KML etc
\n0 – Root – The base asset version used for visual images or other asset types where having various image types might not make sense
\n2 – Image – a JPEG image
\n3 – Raster – a raster data set representation of a thermal or advi field image
\n6 – KML – a geo-referenced KML file of a field image
\n7 – KMZ – a geo-referenced KMZ file of a field image
\n8 – GeoTIFF – a geo-referenced Geo Tiff file which is a ZIP folder with a TIFF Image and a World File
\n9 – GeoJPEG – a geo-referenced Geo JPEG file which is a ZIP folder with a JPEG Image and a World File
\nAll coordinates referenced in this API assume the WGS84 coordinate system.
\nAll dates are assumed to be in ISO 8601 date only format, ie yyyy-MM-dd.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Description:","slug":"api-description"},{"content":"How to Use:","slug":"how-to-use"},{"content":"Some General Concepts:","slug":"some-general-concepts"}],"owner":"1765269","collectionId":"19553b7d-3433-fc59-8a9d-0ee3de4ea693","publishedId":"7LhjRVE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-12-15T16:44:02.000Z"},"item":[{"name":"Get Field Closest To Location","id":"517f909e-9ba7-32bd-462a-2a0925be36f1","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{airscoutcloud_base_url}}/external-partners-api/{{externalPartnerId}}/field/center?latitude=41.323454&longitude=-87.476835","description":"Use this resource to find a field by it’s center. The routine will look for the field who’s center as defined by Airscout is closest to the given point. There is a max search radius of 1,000 feet. It is expected that this resource be used for configuration when setting up field mappings that should only need to happen once per field and not to be called on every image request for a field.
\n","urlObject":{"path":["external-partners-api","{{externalPartnerId}}","field","center"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"latitude of center of field being requested
\n","type":"text/plain"},"key":"latitude","value":"41.323454"},{"description":{"content":"longitude of center of field being requested
\n","type":"text/plain"},"key":"longitude","value":"-87.476835"}],"variable":[]}},"response":[],"_postman_id":"517f909e-9ba7-32bd-462a-2a0925be36f1"},{"name":"Get Airscout Field ID for External Partner ID","id":"5d776f9f-4ac4-84bf-1063-df505a7fdb1a","request":{"method":"GET","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{airscoutcloud_base_url}}/external-partners-api/{{externalPartnerId}}/field?externalPartnerFieldId=11122","description":"Use this resource to check and see what an Airscout field ID is mapped to for a given external partner’s field ID. An ID of -1 will be returned if no mapping is present
\n","urlObject":{"path":["external-partners-api","{{externalPartnerId}}","field"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"Field ID as defined in the external partners ID set
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"11122"}],"variable":[]}},"response":[],"_postman_id":"5d776f9f-4ac4-84bf-1063-df505a7fdb1a"},{"name":"Add External Partner Field ID to Airscout Field ID Mapping","id":"7e542dcc-dde6-69c6-6a52-bb2a0941d0b4","request":{"method":"POST","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{airscoutcloud_base_url}}/external-partners-api/{{externalPartnerId}}/field?externalPartnerFieldId=725&airscoutFieldId=1234","description":"Use this resource to map an Airscout field ID to an External Partner field ID. There is also a UI provided in the Hierarchy Management web application on the field page to manually manage External Partner field mappings.
\n","urlObject":{"path":["external-partners-api","{{externalPartnerId}}","field"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"Field ID as defined in the external partners ID set
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"725"},{"description":{"content":"Field ID as defined in Airscout’s ID set
\n","type":"text/plain"},"key":"airscoutFieldId","value":"1234"}],"variable":[]}},"response":[],"_postman_id":"7e542dcc-dde6-69c6-6a52-bb2a0941d0b4"},{"name":"Get Field Image Meta Data By External Partner ID","id":"8f0b4e85-9184-9459-9ff3-79d0b37b56c8","request":{"method":"GET","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{airscoutcloud_base_url}}/external-partners-api/{{externalPartnerId}}/fieldimage/metadata/field/450091?startDate=2015-01-01&endDate=2015-07-01&type=1","description":"Use this resource to retrieve general field image meta data using an external partner field ID. This returns general meta data about an image asset that could have several resource variations, it is NOT an explicit image link.
\n","urlObject":{"path":["external-partners-api","{{externalPartnerId}}","fieldimage","metadata","field","450091"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"Optional : The start cut off date for field images in collection to be returned
\n","type":"text/plain"},"key":"startDate","value":"2015-01-01"},{"description":{"content":"Optional : The end cut off date for field images in collection to be returned
\n","type":"text/plain"},"key":"endDate","value":"2015-07-01"},{"description":{"content":"Optional : The type of image you would like to request meta data about.\n0 – Thermal\n1 – Visual\n2 – ADVI\n3 – Custom\n-1 – Any
\n","type":"text/plain"},"key":"type","value":"1"}],"variable":[]}},"response":[],"_postman_id":"8f0b4e85-9184-9459-9ff3-79d0b37b56c8"},{"name":"Get Field Image Requested Resource","id":"cc20042e-dfaa-6d70-e61b-a7d44d20d327","request":{"method":"GET","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{airscoutcloud_base_url}}/external-partners-api/{{externalPartnerId}}/fieldimage/requestedresource/93841?externalPartnerFieldId=11221&width=-1&bands=3&clipped=false&assetVersion=0&resourceVariation=0","description":"Use this resource to retrieve a specific field image resource, ie an image of a particular width, a KML version of an image etc
\n","urlObject":{"path":["external-partners-api","{{externalPartnerId}}","fieldimage","requestedresource","93841"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"Field ID as defined in the external partners ID set
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"11221"},{"description":{"content":"Optional : The width of the image to be returned. The image will return the full width original image if no width is defined.
\n","type":"text/plain"},"key":"width","value":"-1"},{"description":{"content":"Optional : This parameter really only applies for GeoTIFF and possibly other raster based asset resources. The supported values are either 1 band (data) or 3 band (RGB)
\n","type":"text/plain"},"key":"bands","value":"3"},{"description":{"content":"Optional : Not currently support for all types but is a boolean value that indicates if the image or data setup should be clipped to the field.
\n","type":"text/plain"},"key":"clipped","value":"false"},{"description":{"content":"Optional : The “Asset Version” (see above) of the specific resource being requested. The default is Root or Normalized. See the section “Some General Concepts” above for details about what the different asset version codes are and what those asset versions mean.
\n","type":"text/plain"},"key":"assetVersion","value":"0"},{"description":{"content":"Optional : The “Resource Variation” (see above) of the specific resource being requested. The default is a JPEG Image. See the section “Some General Concepts” above for details about what the different resource variation codes are and what those resource variations mean.
\n","type":"text/plain"},"key":"resourceVariation","value":"0"}],"variable":[]}},"response":[],"_postman_id":"cc20042e-dfaa-6d70-e61b-a7d44d20d327"}]}