# ourskyai-sda-api
The basic flow for a new organization is as follows:
1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#tag/satellite-targets/get/v1/satellite-targets) endpoint. Copy the id of the target you want to observe.
2. Create an organization target with the [organization target](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above.
3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs.
Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.3.5667
- Package version: 1.3.5667
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
```sh
pip install ourskyai_sda_api
```
(you may need to run `pip` with root permission: `sudo pip install ourskyai_sda_api`)
### Poetry install
If you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:
```sh
poetry add ourskyai_sda_api
```
### Import the package
Then import the package:
```python
import ourskyai_sda_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import os
import ourskyai_sda_api
from ourskyai_sda_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.prod.oursky.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = ourskyai_sda_api.Configuration(
host = "https://api.prod.oursky.ai"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: BearerToken
configuration = ourskyai_sda_api.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ourskyai_sda_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ourskyai_sda_api.DefaultApi(api_client)
v1_create_image_set_request = ourskyai_sda_api.V1CreateImageSetRequest() # V1CreateImageSetRequest |
try:
api_response = api_instance.v1_create_image_set(v1_create_image_set_request)
print("The response of DefaultApi->v1_create_image_set:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->v1_create_image_set: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.prod.oursky.ai/docs/sda*
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="BearerToken"></a>
### BearerToken
- **Type**: Bearer authentication
<a id="Roles"></a>
### Roles
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "ourskyai_sda_api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, OurSky SDA",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/62/34/30c9908e35c169e30645161b2eb132aa9ba84162b2e8d79b44452ef17e5a/ourskyai_sda_api-1.3.5667.tar.gz",
"platform": null,
"description": "# ourskyai-sda-api\nThe basic flow for a new organization is as follows:\n1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#tag/satellite-targets/get/v1/satellite-targets) endpoint. Copy the id of the target you want to observe.\n2. Create an organization target with the [organization target](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above.\n3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs.\n\nCheck out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.3.5667\n- Package version: 1.3.5667\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\n```sh\npip install ourskyai_sda_api\n```\n(you may need to run `pip` with root permission: `sudo pip install ourskyai_sda_api`)\n\n### Poetry install\nIf you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:\n\n```sh\npoetry add ourskyai_sda_api\n```\n\n### Import the package\n\nThen import the package:\n```python\nimport ourskyai_sda_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport os\nimport ourskyai_sda_api\nfrom ourskyai_sda_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.prod.oursky.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = ourskyai_sda_api.Configuration(\n host = \"https://api.prod.oursky.ai\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: BearerToken\nconfiguration = ourskyai_sda_api.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith ourskyai_sda_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = ourskyai_sda_api.DefaultApi(api_client)\n v1_create_image_set_request = ourskyai_sda_api.V1CreateImageSetRequest() # V1CreateImageSetRequest | \n\n try:\n api_response = api_instance.v1_create_image_set(v1_create_image_set_request)\n print(\"The response of DefaultApi->v1_create_image_set:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->v1_create_image_set: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.prod.oursky.ai/docs/sda*\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"BearerToken\"></a>\n### BearerToken\n\n- **Type**: Bearer authentication\n\n<a id=\"Roles\"></a>\n### Roles\n\n\n\n## Author\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "OurSky SDA",
"version": "1.3.5667",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" oursky sda"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e93e41ff1734f06c35c67d4df38722dabae8eba8cebcf3063a3755daf865801",
"md5": "a96a523cbefb20746ce4a048af8d604d",
"sha256": "65c5baf709caa7063be6bcaf0dd6d30abad449be0aa6b7af749783caf95601a2"
},
"downloads": -1,
"filename": "ourskyai_sda_api-1.3.5667-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a96a523cbefb20746ce4a048af8d604d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 111044,
"upload_time": "2024-12-15T01:00:49",
"upload_time_iso_8601": "2024-12-15T01:00:49.860864Z",
"url": "https://files.pythonhosted.org/packages/5e/93/e41ff1734f06c35c67d4df38722dabae8eba8cebcf3063a3755daf865801/ourskyai_sda_api-1.3.5667-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "623430c9908e35c169e30645161b2eb132aa9ba84162b2e8d79b44452ef17e5a",
"md5": "ae7d422bab19528725011560aeae10be",
"sha256": "cfe4b860e25b5ba315c89edc04e15e4cc4b9e20c8f7f508955dd60ca0a90d32a"
},
"downloads": -1,
"filename": "ourskyai_sda_api-1.3.5667.tar.gz",
"has_sig": false,
"md5_digest": "ae7d422bab19528725011560aeae10be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 46725,
"upload_time": "2024-12-15T01:00:52",
"upload_time_iso_8601": "2024-12-15T01:00:52.527385Z",
"url": "https://files.pythonhosted.org/packages/62/34/30c9908e35c169e30645161b2eb132aa9ba84162b2e8d79b44452ef17e5a/ourskyai_sda_api-1.3.5667.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 01:00:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "ourskyai_sda_api"
}
JSON
