web-oto-dev-sdk 1.0.11

API v1 for web.oto.dev service

WebOtoDevSdk Python SDK 1.0.11

Welcome to the WebOtoDevSdk SDK documentation. This guide will help you get started with integrating and using the WebOtoDevSdk SDK in your project.

Versions

• API version: 1.0.11
• SDK version: 1.0.11

About the API

API v1 for web.oto.dev service

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install web_oto_dev_sdk

Authentication

API Key Authentication

The WebOtoDevSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

WebOtoDevSdk(
    project_id="my-project-slug-or-uid",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from web_oto_dev_sdk import WebOtoDevSdk

sdk = WebOtoDevSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from web_oto_dev_sdk import WebOtoDevSdk

sdk = WebOtoDevSdk(
    project_id="my-project-slug-or-uid",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.admin.projects()

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from web_oto_dev_sdk import WebOtoDevSdkAsync

sdk = WebOtoDevSdkAsync(
    project_id="my-project-slug-or-uid",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)


async def main():
  result = await sdk.admin.projects()
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
admin
project
properties
meanings
formulas
values
layouts
crm
crm_deals

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
ProjectInfo
Property
Meaning
Formula
Value
FormField
HttpValidationError
ValidationError

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.