APIドキュメント

APIの接続方法と仕様をご確認いただけます。

 
APIキーを取得する

認証方式

すべてのAPIリクエストには、Authorization ヘッダーによるAPIキー送信が必要です。

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://koenavi.jp/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

エラーについて

標準的なHTTPステータスコードを使用してリクエストの成否を返します。

{
    "errors": [
        {
            "title": "API\u3078\u306e\u30a2\u30af\u30bb\u30b9\u6a29\u9650\u304c\u3042\u308a\u307e\u305b\u3093\u3002",
            "status": 401
        }
    ]
}
200 リクエスト成功
400 不正なリクエスト - 必須パラメータの不足または無効
401 認証エラー - APIキーが不足または無効
404 要求されたリソースが見つかりません
429 リクエスト過多 - レート制限超過
500 サーバー内部エラー
特に指定がない限り、すべてのAPIレスポンスは UTC タイムゾーンで動作します。
ユーザー情報
リンク管理
アクセス統計
pixels.title
splash_pages.title
qr_codes.title
受信データ一覧（ご意見・回答）
通知ハンドラー
独自ドメイン管理
アクティビティログ