• Contact Us close
  • Home
  • Welcome to Alteia keyboard_arrow_right
    Getting Started keyboard_arrow_right
    Quick Guide to the Alteia Software Interface Notification Center Alteia Glossary
    Platform Administration keyboard_arrow_right
    System Requirements and Supported Browsers Account and User Roles Management Company Information Edition User Profile Edition Alteia's Terms of Use - October 2021
    Release Notes keyboard_arrow_right
    Release Note R2022.35 - August 30th, 2022 Release Note R2022.43 - October 25th, 2022 Release Note R2022.47 - November 22th, 2022
    Get Support keyboard_arrow_right
    Contact Support Platform Status
  • The Alteia Platform keyboard_arrow_right
    Fuse
    Build
    Deploy
  • Applications by Industry keyboard_arrow_right
    Worksite Management keyboard_arrow_right
    Site Settings for Mines & Aggregates Material Management Safety and High Walls Analytics Building Information Modeling (BIM) Solar Plant Thermal Inspection Change Map Advanced Stockpile Analytics and Stockpile Module Haul Roads Analytics
    Field Trial Analysis keyboard_arrow_right
    Microplot Designer Plant Height from RGB and Multispectral Plant Count and Emergence for Trial Field Scouting Maps Generic and Custom Scouting Maps Custom Composition Map Supported Crops for Trial Fields & Production Fields Row Vectorization Microplot Boundaries Adjustment Task Fraction of Vegetation Cover (FCover) Flowering Characterization Stay Green Plant Height from LiDAR Statistics for Trial Fields and Production Fields Agriculture and Forestry Analytics Description
    Mine Productivity Analysis keyboard_arrow_right
    Haul Roads Analytics Site Settings for Mines & Aggregates Material Management Safety and High Walls Analytics Change Map Advanced Stockpile Analytics and Stockpile Module
    Plantation and Forestry Management keyboard_arrow_right
    Supported Plantations and Forests Advanced Tree Analysis Tree Detection Grid Designer Tree Density Indicators Agriculture and Forestry Analytics Description
    Precision Agriculture keyboard_arrow_right
    Scouting Maps Generic and Custom Scouting Maps Custom Composition Map Field Boundaries Creation Supported Crops for Trial Fields & Production Fields Fraction of Vegetation Cover (FCover) Stay Green Statistics for Trial Fields and Production Fields Grid Designer Weed Management Plant Count for Production Field Emergence Characterization for Production Field Agriculture and Forestry Analytics Description
  • For Developers keyboard_arrow_right
    SDK and APIs keyboard_arrow_right
    SDK Introduction SDK Use Case Examples Custom Analytics Creation with CLI API Calls Using Alteia and YOLO to Train and Run Detection Models
US
FR
Contact Us
  • Home
  • Welcome to Alteia keyboard_arrow_right
    Getting Started keyboard_arrow_right
    Quick Guide to the Alteia Software Interface Notification Center Alteia Glossary
    Platform Administration keyboard_arrow_right
    System Requirements and Supported Browsers Account and User Roles Management Company Information Edition User Profile Edition Alteia's Terms of Use - October 2021
    Release Notes keyboard_arrow_right
    Release Note R2022.35 - August 30th, 2022 Release Note R2022.43 - October 25th, 2022 Release Note R2022.47 - November 22th, 2022
    Get Support keyboard_arrow_right
    Contact Support Platform Status
  • The Alteia Platform keyboard_arrow_right
    Fuse
    Build
    Deploy
  • Applications by Industry keyboard_arrow_right
    Worksite Management keyboard_arrow_right
    Site Settings for Mines & Aggregates Material Management Safety and High Walls Analytics Building Information Modeling (BIM) Solar Plant Thermal Inspection Change Map Advanced Stockpile Analytics and Stockpile Module Haul Roads Analytics
    Field Trial Analysis keyboard_arrow_right
    Microplot Designer Plant Height from RGB and Multispectral Plant Count and Emergence for Trial Field Scouting Maps Generic and Custom Scouting Maps Custom Composition Map Supported Crops for Trial Fields & Production Fields Row Vectorization Microplot Boundaries Adjustment Task Fraction of Vegetation Cover (FCover) Flowering Characterization Stay Green Plant Height from LiDAR Statistics for Trial Fields and Production Fields Agriculture and Forestry Analytics Description
    Mine Productivity Analysis keyboard_arrow_right
    Haul Roads Analytics Site Settings for Mines & Aggregates Material Management Safety and High Walls Analytics Change Map Advanced Stockpile Analytics and Stockpile Module
    Plantation and Forestry Management keyboard_arrow_right
    Supported Plantations and Forests Advanced Tree Analysis Tree Detection Grid Designer Tree Density Indicators Agriculture and Forestry Analytics Description
    Precision Agriculture keyboard_arrow_right
    Scouting Maps Generic and Custom Scouting Maps Custom Composition Map Field Boundaries Creation Supported Crops for Trial Fields & Production Fields Fraction of Vegetation Cover (FCover) Stay Green Statistics for Trial Fields and Production Fields Grid Designer Weed Management Plant Count for Production Field Emergence Characterization for Production Field Agriculture and Forestry Analytics Description
  • For Developers keyboard_arrow_right
    SDK and APIs keyboard_arrow_right
    SDK Introduction SDK Use Case Examples Custom Analytics Creation with CLI API Calls Using Alteia and YOLO to Train and Run Detection Models
  • Home
  • keyboard_arrow_right For Developers
  • keyboard_arrow_right SDK and APIs

SDK Introduction

The Alteia SDK (Software Development Kit) is a high-level Python set of tools, libraries and code samples developed to leverage Alteia's APIs. With it, developers quickly create, test, and develop specific applications on top of the Alteia platform. This allows you to enrich the user experience and business workflows with advanced functionality. In addition, you can seamlessly integrate Alteia with other applications, for example, to send push notifications and data, and collect industry-specific or customer-specific analytics.

The kit consists of a code library, examples, documentation, and the methodology necessary to perform specific functions, essentially everything you need to create your own modules and retrieve analytics.

You can use the Alteia SDK to do the following:

  • Connect remotely to the platform to exchange and manage data input/output
  • Fetch a project, browse its missions
  • List deliverables, download files
  • Create a new project with pictures or vectors
  • Annotate‍ data in a project
  • Search for annotations associated with a project
  • Update & delete annotations (update geometry, properties, and other attributes)
  • Annotate an image
  • Process a raster and deliver output
  • Fetch a process area from an annotation
  • Train or run a custom algorithm as a subprocess
  • Upload and deliver the algorithm output

Before you begin

Before you start implementing the Alteia SDK, make sure to do the following:

Install

Install the latest Alteia Python package release via pip:

pip install alteia

The Alteia Python SDK has a unique entry point through the "alteia.sdk.SDK" class. So, to use the SDK, first configure your Alteia credentials with a configuration file. All configuration files must be written in JSON format as a single JSON object, using only the supported properties:

user
The user identifier. Required is not provided through a configuration file, nor using "client_id."
password
The account password. Required if not provided through a configuration file and "user" is used.
client_id
An OAuth client identifier. Required if not provided through a configuration file and "user" is used.
client_secret
The OAuth client secret. Required if not provided through a configuration file and "client_id" is used.
access_token
An optional API access token to use to authenticate requests as an alternative to using "user" or "client_id."
url
The public endpoint of Alteia. Default to "https://app.alteia.com."
connection
A dictionary providing the connection configuration
proxy_url
An optional proxy URL. The value of "https_proxy" or "http_proxy" environment variable will override if set.

Here is an example of the "config-connection.json" configuration file:

{"user": "firstname.lastname@example.com",
"password": "20h!nph-14-12394"}
The path of the default configuration file depends on the operating system and is documented with the "alteia.core.config.ConnectionConfig" class. Based on your operating system, create the following directory and save the config-connection.json file in:
Windows:
%USERPROFILE%\Application\Application Data\Alteia\alteia\ 
Linux:
~/.local/share/alteia/
MacOS:
~/Library/Application Support/alteia/

To go further

You can find all the information about the Alteia SDK by clicking on the link below:

Access the SDK documentation

Was this article helpful?

sentiment_satisfied

Yes

sentiment_dissatisfied

No

  • search icon
  • sdk
  • developer

RELATED QUESTIONS

  • Custom Analytics Creation with CLI arrow_forward
  • SDK Use Case Examples arrow_forward

Was this article helpful?

sentiment_satisfied

Yes

sentiment_dissatisfied

No

RELATED QUESTIONS

  • Custom Analytics Creation with CLI arrow_forward
  • SDK Use Case Examples arrow_forward

Sorry, we didn't find any relevant articles for you.

Please fill out the contact form below and we will reply as soon as possible.




Take the next step.

Request a demo or schedule a meeting to discuss your digital transformation ambitions.

Contact Us

Connect with us.

The world of Ai changes fast. Keep up to date with the Alteia platform by signing up to our newsletter :

Thank you for your message.

© 2021 Alteia. All rights reserved

LEGAL NOTICE
PRIVACY POLICY

© 2021 Alteia. All rights reserved

facebook logo
twitter logo
linkedin logo