開発 API

概要

API やウェブフックに関する情報を取得できます。

list-api-logs-last-3-days

API URL:

https://api.tobi.shiguredo.app/team/list-api-logs-last-3-days

直近 3 日間分の API ログを最大 1000 件取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/list-api-logs-last-3-days \
    -vvv

list-webhook-logs-last-3-days

API URL:

https://api.tobi.shiguredo.app/team/list-webhook-logs-last-3-days

直近 3 日間分のウェブフックログを最大 1000 件取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/list-webhook-logs-last-3-days \
    -vvv

get-total-api-requests-last-month

API URL:

https://api.tobi.shiguredo.app/team/get-total-api-requests-last-month

先月の API のリクエスト回数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app//team/get-total-api-requests-last-month \
    -vvv

get-total-api-requests-this-month

API URL:

https://api.tobi.shiguredo.app/team/get-total-api-requests-this-month

今月の API のリクエスト回数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app//team/get-total-api-requests-this-month \
    -vvv

get-total-webhook-requests-last-month

API URL:

https://api.tobi.shiguredo.app/team/get-total-webhook-requests-last-month

先月のウェブフックのリクエスト回数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/get-total-webhook-requests-last-month \
    -vvv

get-total-webhook-requests-this-month

API URL:

https://api.tobi.shiguredo.app/team/get-total-webhook-requests-this-month

今月のウェブフックのリクエスト回数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/get-total-webhook-requests-this-month \
    -vvv

update-webhook-settings

API URL:

https://api.tobi.shiguredo.app/team/update-webhook-settings

ウェブフックを設定します。

  • sora_auth_webhook_url

  • sora_session_webhook_url

  • sora_event_webhook_url

  • webhook_url

複数指定可能です。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/update-webhook-settings \
    sora_auth_webhook_url=https://example.com/sora/webhook/auth \
    sora_event_webhook_url=https://example.com/sora/webhook/event \
    -vvv

一つだけでも指定可能です。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/update-webhook-settings \
    sora_session_webhook_url=https://example.com/sora/webhook/session \
    -vvv

削除は null を指定します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/update-webhook-settings \
    sora_auth_webhook_url:=null \
    -vvv

get-webhook-settings

API URL:

https://api.tobi.shiguredo.app/team/get-webhook-settings

ウェブフックの URLs を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/get-webhook-settings \
    -vvv
© Copyright 2022, Shiguredo Inc. Created using Sphinx 5.0.0