紹介

あなたはどの言語を使用してもHTTPリクエストを送信して私たちのGraphQL API / REST APIと対話することができます。使用する前に、DashboardでAPIキーを作成する必要があります。

APIキーの作成

Dashboard上で、右側のドロップダウンメニュー中の Settingsをクリックし、次いで左側のサイドバー Developerをクリックすると、開発者のオプションが表示されます。

API Keyの項目を見つけ、 Generate New TokenボタンをクリックするとAPIキーが生成されます。

ViewボタンをクリックするとAPIキーを確認することができます。

CopyボタンをクリックするとAPIキーをコピーすることができます。

APIキーの使用

認証

Zeabur APIはAPIキーを使って身元を確認することができます。有効なAPIキーが生成されていることを確認してください。

すべてのAPIリクエストは Authorization HTTPヘッダーにあなたのAPIキーを含める必要があります。下記のようになります：

Authorization: Bearer ZEABUR_API_KEY

REST APIリクエストを発行する

あなたは任意のHTTPクライアントライブラリやあなたのアプリケーション内でリクエストを発行することができます。以下に例を示します：

以下のコマンドをターミナルに貼り付けて、最初のREST APIリクエストを行ってください。$ZEABUR_API_KEYをあなたのAPIキーに置き換えてください。

curl https://api.zeabur.com/api/v1/users/me \
  -H "Authorization: Bearer $ZEABUR_API_KEY" \
  -H "Content-Type: application/json" \

ここでは現在のユーザーの情報を照会しています。あなたは以下のような応答を受け取るはずです：

{
    "_id": "64ffffffffffffffffff",
    "name": "Zeabur Zebra",
    "email": "zebra@zeabur.com",
    "username": "zeabra",
    "language": "ja-JP",
    "githubID": 5000000,
    "avatarUrl": "https://avatars.githubusercontent.com/u/5000000?v=4",
    "createdAt": "2023-08-31T08:14:08.873Z",
    "bannedAt": null,
    "bannedReason": null,
    "emailPreference": {
        "buildFailed": true,
        "deploymentCrashed": true
    },
    "agreedAt": "2023-08-31T08:14:17.028Z",
    "referralCode": "zeabra",
    "discordID": "7000000000000000000",
    "customerID": "cus_xxxxxxxxxxxxxx"
}

これであなたはAPIキーを用いて身元を確認することに成功しました。他のREST APIにアクセスするためにAPIキーを使用することができます。

GrapQL APIへのアクセス方法は上記と同様で、リクエスト方法だけが異なります。あなたは GraphQL Playgroundで Graphql APIを試すことができます。