Skip to main content
AltoPocket
開発者

AltoPocket 連携 API

承認済みパートナープラットフォーム向けのサーバー間連携です。すべてのリクエストはキーで署名され、承認されたキーでできることは承認後に開発者コンソールで確認できます。

仕組み

承認済みパートナー専用

会社情報、担当者、サーバー IP で申請します。すべての申請は AltoPocket のオペレーターが審査します。

機能は承認後にご案内

承認後、開発者コンソールでこのキーに付与できる権限を確認し、必要な権限を理由とともにリクエストします。

署名付きのサーバー間呼び出し

すべての呼び出しにはキーと HMAC 署名が含まれ、許可リストのサーバー IP からのみ受け付けます。

価値が移動する処理は自動では実行されません。AltoPocket のオペレーターが承認します。

リクエストの署名方法

各リクエストには API キー(x-api-key)、Unix タイムスタンプ(X-AP-Timestamp、±5 分以内)、X-AP-Signature が必要です。署名は、タイムスタンプ・HTTP メソッド・クエリ文字列を含むパス・本文バイトの SHA-256 を改行で連結した文字列に対する、署名シークレットの HMAC-SHA256 です。すべての POST には Idempotency-Key も必要で、許可リストに登録したサーバー IP からのみ呼び出せます。

Swagger リファレンスの "Try it out" はブラウザでリクエストに署名できます。サンドボックスのキーのみを使い、本番の署名シークレットは決してブラウザに貼り付けないでください。

公開リファレンスには署名方法、接続確認、申請のみが含まれます。承認済みパートナーは自分の権限に応じた完全なリファレンスを閲覧できます。Swagger ページでサンドボックスキーを入力して「Unlock full docs」を選ぶか、サーバーから GET /integrations/v1/docs/openapi.json(署名が必要)を取得してください。

Swagger でのテスト

Try it out はブラウザでリクエストごとに署名するため、リクエストはブラウザの公開 IP から送信され、その IP がキーに許可されている必要があります:本番サーバー IP、サンドボックスのテスター IP、または AltoPocket の運用担当がクライアントに設定できるサンドボックスの「すべての IP を許可」のいずれか。署名パネルの「Check my IP」で API から見える IP を確認でき、拒否された呼び出しはどの IP が拒否されたかを示します。本番の署名シークレットは決してブラウザに貼り付けないでください。

canonical = timestamp + "\n"
          + METHOD + "\n"
          + path_with_query + "\n"
          + hex(sha256(raw_body))

X-AP-Signature = hex(hmac_sha256(secret, canonical))
x-api-key      = apk_…
X-AP-Timestamp = unix seconds (±300 s)
Idempotency-Key = <every POST>

環境

サンドボックス

テストネットワーク(TRON Nile)とテストデータです。ここで発行されるキーは apk_dev_ または apk_stage_ で始まります。

  • https://api.devkcw.com/api/v1/integrations/v1

本番

本番環境です。キーは apk_live_ で始まり、サンドボックスとは別に発行されます。

https://api.altopocket.com/api/v1/integrations/v1

権限は承認後にリクエストします

申請では権限を求めません。キーが承認され受け取った後、開発者コンソール(またはキーで署名した GET /integrations/v1/scopes)で各権限でできることを確認し、必要な権限を理由とともにリクエストします。すべてのリクエストはオペレーターが審査します。

開発者コンソールを開く

API キーを申請

アカウントは不要です。会社情報、呼び出し元サーバーの IP、構築する内容をお知らせください。申請では権限を求めません。承認後、ステータストークンでキーを一度だけ受け取り、そのキーで開発者コンソールから必要な権限をリクエストします。すべての申請と権限リクエストは AltoPocket のオペレーターが審査します。

国際形式(+国番号…)、または左の国コードと国内番号。暗号化して保存します。

ポート 443 の https、公開ホストのみ。

公開 IP または /24 以下の IPv4 範囲を 1 行に 1 つ、最大 20 件。

ブラウザで署名する Swagger「Try it out」の呼び出しはお使いの PC から送信されるため、その公開 IP が許可されている必要があります。サンドボックス(dev/stage)でのみ使用され、本番では拒否されます。サーバー IP と同じルールで最大 10 件。

ここでは権限を選びません。承認後、発行されたキーで開発者コンソールからリクエストしてください。

20 文字以上。

すべての申請は AltoPocket の運営者が審査します。

開発者 — 連携 API · AltoPocket