Skip to content

Obfuscate example tokens and Sentera IDs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
denisahearn merged 3 commits into from
May 12, 2026
Merged

Obfuscate example tokens and Sentera IDs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2dd754b
Security updates
denisahearn May 11, 2026
d095496
More security updates
denisahearn May 11, 2026
e3ed687
Replace placeholder Sentera IDs with <YOUR ID> placeholders
denisahearn May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 11 additions & 9 deletions api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<YOUR ACCESS TOKEN> ruby upsert_feature_set.rb
```

Replace `<YOUR ACCESS TOKEN>` 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
Expand All @@ -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="<Optional name, otherwise generated from inputs>" ruby create_ground_scouting_feature_set.rb` |
| Ruby | `$ ruby import_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=<YOUR SURVEY 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=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=<YOUR SURVEY 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=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com FIELD_SENTERA_ID=<YOUR FIELD ID> FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" ruby import_files.rb` |
| Ruby | `$ ruby upsert_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com SURVEY_SENTERA_ID=<YOUR SURVEY 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=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" FIELD_SENTERA_ID=<YOUR FIELD ID> ORGANIZATION_SENTERA_ID=<YOUR ORGANIZATION ID> ruby upsert_files.rb` |
| Ruby | `$ ruby upsert_images.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com IMAGES_PATH="../test_files" SURVEY_SENTERA_ID=<YOUR SURVEY ID> FILE_EXT="*.jpeg" SENSOR_TYPE="RGB" ruby upsert_images.rb` |
| Ruby | `$ ruby upsert_mosaics.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" SURVEY_SENTERA_ID=<YOUR SURVEY ID> ruby upsert_mosaics.rb` |
| Ruby | `$ ruby create_ground_scouting_feature_set.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER="https://api.sentera.com" SURVEY_SENTERA_ID=<YOUR SURVEY 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="<Optional name, otherwise generated from inputs>" ruby create_ground_scouting_feature_set.rb` |
89 changes: 0 additions & 89 deletions test_files/test.geojson
View file
Open in desktop

This file was deleted.

Binary file removed test_files/test.jpeg
View file
Open in desktop
Binary file not shown.
Binary file removed test_files/test.tif
View file
Open in desktop
Binary file not shown.
Binary file removed test_files/test2.jpeg
View file
Open in desktop
Binary file not shown.
Binary file removed test_files/test3.jpeg
View file
Open in desktop
Binary file not shown.
8 changes: 5 additions & 3 deletions upload_files/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<YOUR ACCESS TOKEN> ruby multipart_file_upload.rb
```

Replace `<YOUR ACCESS TOKEN>` 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
Expand Down Expand Up @@ -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=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.geojson" CONTENT_TYPE="application/json" OWNER_TYPE=SURVEY OWNER_SENTERA_ID=<YOUR OWNER ID> ruby file_upload.rb` |
| Ruby | `$ ruby multipart_file_upload.rb` | `FIELDAGENT_ACCESS_TOKEN=<YOUR ACCESS TOKEN> FIELDAGENT_SERVER=https://api.sentera.com FILE_PATH="../test_files/test.tif" CONTENT_TYPE="image/tiff" PARENT_SENTERA_ID=<YOUR PARENT ID> ruby multipart_file_upload.rb` |