はじめに
Pythonライブラリは、Pythonで書かれたアプリケーションから『Karaden SMS API』へ簡単にアクセスするための手段を提供します。
それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、『Karaden SMS API』の幅広いバージョンと互換性があります。
動作環境
Python 3.7～3.10
パッケージマネージャについて
本ライブラリはパッケージマネージャとしてpipを利用することを想定しています。
※pipはPython 3.4以降には、標準で付属しているパッケージマネージャーなので、インストールなどの対応は特に必要ありません。
言語ライブラリのダウンロード
pip（Python）が実行可能な環境下で、下記を実行してください。
pip install --upgrade karaden-prg-python
使い方
このライブラリを使用するには、『Karaden SMS API』でテナントを作成し、プロジェクト毎に発行できるトークンを発行し、サービスを登録する必要があります。
作成したテナントID（テナントIDはテナント選択画面で表示されています）は、`Config.tenant_id`に、発行したトークンは`Config.api_key`に、サービスIDは`with_service_id`にそれぞれ設定します。
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(<サービスID>)
.with_to('09012345678')
.with_body('本文')
.build()
)
request_options = Config.as_request_options()
try:
message = Message.create(params,request_options)
print(vars(message))
except Exception as e:
print(vars(e))
※本コードはSMS送信部分の概念を切り出したものです。実際のコードについては次のサンプルコードを参照下さい。