Skip to main content

OurSky SDA

Project description

ourskyai-sda-api

The basic flow for a new organization is as follows:

  1. View the available satellite targets with the satellite targets endpoint. Copy the id of the target you want to observe.
  2. Create an organization target with the organization target endpoint. Use the id copied from above.
  3. Create a webhook with the webhook endpoint to receive TDMs automatically (preferred) or use the tdms endpoint to poll for TDMs.

Check out our examples repository to see usage in each language.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.3.3942
  • Package version: 1.3.3942
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

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 then you can add the SDK with:

poetry add ourskyai_sda_api

Import the package

Then import the package:

import ourskyai_sda_api

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Authorization

Authentication schemes defined for the API:

BearerToken

  • Type: Bearer authentication

Roles

Author

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ourskyai_sda_api-1.3.3942.tar.gz (42.4 kB view hashes)

Uploaded Source

Built Distribution

ourskyai_sda_api-1.3.3942-py3-none-any.whl (100.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page