Python library for the Karaden API
Project description
Karaden Pythonライブラリ
Karaden Pythonライブラリは、Pythonで書かれたアプリケーションからKaraden APIへ簡単にアクセスするための手段を提供します。 それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、Karaden APIの幅広いバージョンと互換性があります。
インストール方法
パッケージを変更しないならば、このソースコードは必要ありません。 パッケージを使用したいだけならば、下記を実行するだけです。
pip install --upgrade karaden-prg-python
ソースコードからインストールしたいのであるならば、下記を実行します。
python setup.py install
動作環境
Python 3.7~3.10
使い方
このライブラリを使用するには、Karadenでテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。
作成したテナントID(テナントIDはテナント選択画面で表示されています)は、Config.tenant_id
に、発行したトークンはConfig.api_key
にそれぞれ設定します。
from karaden.config import Config
from karaden.param.message_create_params import MessageCreateParams
from karaden.model.message import Message
Config.api_key = '<トークン>'
Config.tenant_id = '<テナントID>'
params = (
MessageCreateParams
.new_builder()
.with_service_id(1)
.with_to('09012345678')
.with_body('本文')
.build()
)
message = Message.create(params)
リクエスト毎の設定
同一のプロセスで複数のキーを使用する必要がある場合、リクエスト毎にキーやテナントIDを設定することができます。
params = (
MessageDetailParams
.new_builder()
.with_id('<メッセージID>')
.build()
)
request_options = (
RequestOptions.new_builder()
.with_api_key('<トークン>')
.with_tenant_id('<テナントID>')
.build()
)
message = Message.detail(params, request_options)
タイムアウトについて
通信をするファイルサイズや実行環境の通信速度によってはHTTP通信時にタイムアウトが発生する可能性があります。
何度も同じような現象が起こる際は、ファイルサイズの調整もしくはRequestOptions
からタイムアウトの時間を増やして、再度実行してください。
request_options = (
RequestOptions.new_builder()
.with_api_key('<トークン>')
.with_tenant_id('<テナントID>')
.with_connection_timeout(<秒>)
.with_read_timeout(<秒>)
.build()
)
bulk_message = BulkMessageService.create('<ファイルパス>', request_options)
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
Built Distribution
Hashes for karaden_prg_python-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d6d80b1cb7df764adc317e85bbbaa61df152b80bedb499e9de37a802c61afec |
|
MD5 | b07d78a9d2d356d0619207431aeee189 |
|
BLAKE2b-256 | f5c965921189b5f19eb6d298c6e389212d7e3079d8306115ff01b48bedbb88f8 |