diff --git a/README.md b/README.md index 627b4c6..90ddc63 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # Introduction -Code examples demonstrating how to use Sentera's APIs +Code examples demonstrating how to use Sentera's APIs. + +Please contact api-support@sentera.com if you need help using these code examples to interact with Sentera's APIs. diff --git a/api/README.md b/api/README.md index 40809c0..2f29886 100644 --- a/api/README.md +++ b/api/README.md @@ -10,9 +10,11 @@ Once you have a valid access token, specify a `FIELDAGENT_ACCESS_TOKEN` environm For example, the command below runs the Ruby multipart file upload example against the FieldAgent staging server: ``` -$ FIELDAGENT_ACCESS_TOKEN=SFaY5r2CAqoVJtlrbfqC62W1UqJUAdQjlnCjB8eqvJg ruby upsert_feature_set.rb +$ FIELDAGENT_ACCESS_TOKEN= ruby upsert_feature_set.rb ``` +Replace `` with your FieldAgent access token. + Or alternately, you can paste your FieldAgent access token into a file named `fieldagent_access_token.txt` that is located in the same directory as the code examples. ## FieldAgent Server @@ -26,11 +28,11 @@ $ FIELDAGENT_SERVER=https://apistaging.sentera.com ruby upsert_feature_set.rb ## Examples | Language | Run Command | Example Command | | :------- | :---------------------------------|-----------------| -| Ruby | `$ ruby import_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby import_feature_set.rb` | -| Ruby | `$ ruby import_feature_set_legacy.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby import_feature_set_legacy.rb` | -| Ruby | `$ ruby import_files.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com FIELD_SENTERA_ID=agwmnou_AS_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" ruby import_files.rb` | -| Ruby | `$ ruby upsert_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby upsert_feature_set.rb` | -| Ruby | `$ ruby upsert_files.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" FIELD_SENTERA_ID=agwmnou_AS_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 ORGANIZATION_SENTERA_ID="jiqn6qi_OR_5qytAcmeOrg_CV_deve_0f569249e_250206_162717" ruby upsert_files.rb` | -| Ruby | `$ ruby upsert_images.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com IMAGES_PATH="../test_files" SURVEY_SENTERA_ID=mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 FILE_EXT="*.jpeg" SENSOR_TYPE="RGB" ruby upsert_images.rb` | -| Ruby | `$ ruby upsert_mosaics.rb` | `FIELDAGENT_ACCESS_TOKEN=PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" SURVEY_SENTERA_ID=mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730 ruby upsert_mosaics.rb` | -| Ruby | `$ ruby create_ground_scouting_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN="PAmnCNUyosKShN9K1AEflLOw6T7bA2fRTWTg-vL3P5Y" FIELDAGENT_SERVER="https://api.sentera.com" SURVEY_SENTERA_ID="mjlmmrw_CO_lk07AcmeOrg_CV_deve_773b47acb_240514_160730" NUM_LOCATIONS=20 NUM_ATTACHMENTS_PER_FEATURE=2 WITH_ATTACHMENTS="none,some,all" ATTACHMENTS_PATH="../test_files" ATTACHMENTS_EXT="*.*" WITH_ATTACHMENT_NAME_KEYS=false,true WITH_ATTACHMENT_NAMES=false,true WITH_NOTES="none,some,all" FEATURE_SET_NAME="" ruby create_ground_scouting_feature_set.rb` | +| Ruby | `$ ruby import_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID= GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby import_feature_set.rb` | +| Ruby | `$ ruby import_feature_set_legacy.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID= GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby import_feature_set_legacy.rb` | +| Ruby | `$ ruby import_files.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com FIELD_SENTERA_ID= FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" ruby import_files.rb` | +| Ruby | `$ ruby upsert_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID= GEOMETRY_PATH="../test_files/test.geojson" FILES_PATH="../test_files" FILE_EXT="*.jpeg" ruby upsert_feature_set.rb` | +| Ruby | `$ ruby upsert_files.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" FIELD_SENTERA_ID= ORGANIZATION_SENTERA_ID= ruby upsert_files.rb` | +| Ruby | `$ ruby upsert_images.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com IMAGES_PATH="../test_files" SURVEY_SENTERA_ID= FILE_EXT="*.jpeg" SENSOR_TYPE="RGB" ruby upsert_images.rb` | +| Ruby | `$ ruby upsert_mosaics.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" SURVEY_SENTERA_ID= ruby upsert_mosaics.rb` | +| Ruby | `$ ruby create_ground_scouting_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER="https://api.sentera.com" SURVEY_SENTERA_ID= NUM_LOCATIONS=20 NUM_ATTACHMENTS_PER_FEATURE=2 WITH_ATTACHMENTS="none,some,all" ATTACHMENTS_PATH="../test_files" ATTACHMENTS_EXT="*.*" WITH_ATTACHMENT_NAME_KEYS=false,true WITH_ATTACHMENT_NAMES=false,true WITH_NOTES="none,some,all" FEATURE_SET_NAME="" ruby create_ground_scouting_feature_set.rb` | diff --git a/test_files/test.geojson b/test_files/test.geojson deleted file mode 100644 index 0f90f7b..0000000 --- a/test_files/test.geojson +++ /dev/null @@ -1,89 +0,0 @@ -{ - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "geometry": { - "type": "LineString", - "coordinates": [ - [ - -94.79915088090505, - 44.097927093782694, - 1 - ], - [ - -94.79915088090505, - 44.097927093782694, - 5 - ], - [ - -94.79915088090505, - 44.097927093782694, - 15 - ], - [ - -94.79915088090505, - 44.097927093782694, - 30 - ], - [ - -94.79915088090505, - 44.097927093782694, - 45 - ], - [ - -94.79915088090505, - 44.097927093782694, - 47 - ], - [ - -94.79915088090505, - 44.097927093782694, - 44 - ], - [ - -94.79915088090505, - 44.097927093782694, - 42 - ], - [ - -94.79915088090505, - 44.097927093782694, - 25 - ], - [ - -94.79915088090505, - 44.097927093782694, - 15 - ], - [ - -94.79915088090505, - 44.097927093782694, - 5 - ] - ] - }, - "properties": { - - } - } - ], - "properties": { - "app_version": "4.2.5", - "dji_sdk_version": "1.1.1.1", - "app_features": [ - ], - "user_sentera_id": "user1234", - "drone_model": "p4p", - "drone_serial_number": "drone1234", - "weather_condition": "Sunny", - "weather_wind_direction": "South East", - "weather_wind_speed": 20, - "weather_wind_speed_unit": "kilometers_per_hour", - "weather_temperature": 65, - "weather_temperature_unit": "fahrenheit", - "weather_dew_point": 38, - "weather_dew_point_unit": "fahrenheit", - "weather_humidity": 67 - } -} diff --git a/test_files/test.jpeg b/test_files/test.jpeg deleted file mode 100644 index 3ddcf0a..0000000 Binary files a/test_files/test.jpeg and /dev/null differ diff --git a/test_files/test.tif b/test_files/test.tif deleted file mode 100755 index 52c74cf..0000000 Binary files a/test_files/test.tif and /dev/null differ diff --git a/test_files/test2.jpeg b/test_files/test2.jpeg deleted file mode 100644 index 34f06dc..0000000 Binary files a/test_files/test2.jpeg and /dev/null differ diff --git a/test_files/test3.jpeg b/test_files/test3.jpeg deleted file mode 100644 index 1788ecf..0000000 Binary files a/test_files/test3.jpeg and /dev/null differ diff --git a/upload_files/README.md b/upload_files/README.md index 25b2131..d800c18 100644 --- a/upload_files/README.md +++ b/upload_files/README.md @@ -8,9 +8,11 @@ Once you have a valid access token, specify a `FIELDAGENT_ACCESS_TOKEN` environm For example, the command below runs the Ruby multipart file upload example against the FieldAgent staging server: ``` -$ FIELDAGENT_ACCESS_TOKEN=SFaY5r2CAqoVJtlrbfqC62W1UqJUAdQjlnCjB8eqvJg ruby multipart_file_upload.rb +$ FIELDAGENT_ACCESS_TOKEN= ruby multipart_file_upload.rb ``` +Replace `` with your FieldAgent access token. + Or alternately, you can paste your FieldAgent access token into a file named `fieldagent_access_token.txt` that is located in the same directory as the code examples. ## FieldAgent Server @@ -43,5 +45,5 @@ Full documentation of this workflow can be found [here](https://api.sentera.com/ ## Examples | Language | Run Command | Example Command | | :------- | :---------------------------------|-----------------| -| Ruby | `$ ruby file_upload.rb` | `FIELDAGENT_ACCESS_TOKEN=AKgnGiLNpk1AjppMqWSWbiNMNUYepcP8EalLo_gYRpM FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" OWNER_TYPE=SURVEY OWNER_SENTERA_ID=9nfdf02_CO_ytwfAcmeOrg_CV_deve_c49295f37_230411_080321 ruby file_upload.rb` | -| Ruby | `$ ruby multipart_file_upload.rb` | `FIELDAGENT_ACCESS_TOKEN=AKgnGiLNpk1AjppMqWSWbiNMNUYepcP8EalLo_gYRpM FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" CONTENT_TYPE="image/tiff" PARENT_SENTERA_ID=9nfdf02_CO_ytwfAcmeOrg_CV_deve_c49295f37_230411_080321 ruby multipart_file_upload.rb` | +| Ruby | `$ ruby file_upload.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" OWNER_TYPE=SURVEY OWNER_SENTERA_ID= ruby file_upload.rb` | +| Ruby | `$ ruby multipart_file_upload.rb` | `FIELDAGENT_ACCESS_TOKEN= FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" CONTENT_TYPE="image/tiff" PARENT_SENTERA_ID= ruby multipart_file_upload.rb` |