Codex · III

API キー

API キーを使用すると、買ボタンを使用せずに、独自のコードからチェックアウトおよびステータスエンドポイントを呼び出せます。独自のチェックアウトまたはサーバー統合を構築している場合のみ必要です。買ボタンを貼り付けている場合は、これは完全にスキップできます。

キーが必要な時

買ボタンはキーなしで機能します—— 公開の、プロジェクトスコープのエンドポイントと通信します。キーはもう 1 つのパスです: 自分のサーバー から行う呼び出し。ここでチェックアウトを作成したり、トランザクションのステータスをコードで読みます。キーはプロジェクトの API キー タブの下にあります。

API キータブ。最初のキーを作成するまで空。

キーを作成する

キーを作成 をクリックして、後で認識できる名前を付けます—— 通常は実行される場所 (「本番サーバー」など)—— キーを生成 をクリックしてください。名前はあなた用のラベルのみです。キーが何をできるかは変わりません (キーはこのプロジェクトに限定されます)。

キーが存在する場所の名前を付けてから、それを生成します。

一度コピーする

キーは生成直後に 一度だけ 表示されます。これは cmk_ で始まります。今すぐコピーして、どこか安全に保存してください—— ハッシュのみを保持するため、再度表示することはできません。それを失い、単に新しいものを作成して古いものを削除します。

これは完全なキーが表示される唯一の時です。閉じる前にコピーしてください。

キーをパスワードのように扱ってください。サーバーサイドコードからのみ使用し、Authorization ヘッダーでベアラートークンとして送信し、Web ページ、パブリックレポ、または購入者のブラウザに送付される場合はどこにも配置しないでください。キーを持つ誰でもあなたのプロジェクトに対して行動できます。

使用、リスト、および取り消し

保存されたキーは、名前、マスクされたプレフィックス、作成日でリストされます。完全なキーは再度表示されません—— プレフィックスはそれらを区別するのに十分です。ゴミ箱アイコン は、キーをすぐに取り消します: まだそれを使用しているコードは拒否され始めるため、新しいキーを最初に作成し、それを配置してから古いものを削除することで回転させます。

このキーは、マスクされたプレフィックスと作成日を表示します。ゴミ箱アイコンはそれを取り消します。

キーで呼び出すことができるもの—— 独自のコードからチェックアウトを作成する、イベントを処理する、ステータスをポーリングする—— については、API の使用 を参照してください。

つなぐ準備はできましたか?

無料プランはほとんどのサイトをカバーし、カードを一切求めません。