APIのドキュメンテーション

利用可能なAPIエンドポイントのドキュメントです。これらはRESTアーキテクチャをベースに構築されています。すべてのAPIエンドポイントは、標準のHTTPレスポンスコードを持つJSONレスポンスを返します。また、APIキーを使用したベアラ認証が必要です。

Get your own API Key

ベースURL

認証

すべてのAPIエンドポイントは、ベアラ認証メソッドで送信されるAPIキーが必要です。

Authorization: Bearer {api_key}

例

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

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

例

{
    "errors": [
        {
            "title": "API\u306b\u30a2\u30af\u30bb\u30b9\u3059\u308b\u6a29\u9650\u304c\u3042\u308a\u307e\u305b\u3093\u3002",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

All API endpoint results work with the UTC timezone unless specified otherwise.

ユーザ

リンク

統計

スプラッシュページ

カスタムQRコード

メール署名

収集されたデータ

Notification handlers

カスタムドメイン

マイアカウントチーム

チームメンバー

アカウント請求

Referred signups

アカウントログ