APIドキュメント

APIの接続と連携方法について

 
独自のAPIキーを取得

認証

すべてのAPIリクエストには、以下に示すように、Authorizationヘッダー経由で送信されるAPIキーによる認証が必要です。

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

エラー

本APIでは、リクエストの成否を示すために、標準的な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 タイムゾーンに基づいています。
ユーザー
リンク
リンク統計
ピクセル
スプラッシュページ
QRコード
データ
通知ハンドラー
アカウントログ