API ドキュメント

これは利用可能なAPIエンドポイントのドキュメントで、RESTアーキテクチャに基づいています。すべてのAPIエンドポイントは、標準のHTTPレスポンスコードとともにJSONレスポンスを返し、APIキーによるベアラ認証が必要です。

Get your own API Key

ベースURL

認証

すべてのAPIエンドポイントは、Bearer Authentication method.によって送信されるAPIキーを必要とします。

Authorization: Bearer {api_key}

例

curl --request GET \
--url 'https://olinke.com/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\u3078\u306e\u30a2\u30af\u30bb\u30b9\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

カスタムドメイン

私のチーム

チームメンバー

アカウントの支払い

アカウントログ