統合をサイトに接続するためのAPIキーの設定、使用、トラブルシューティングの方法を紹介します。

アプリケーション プログラミング インターフェイス (API) を使用することにより、開発者はSquarespaceサイトに接続可能な統合やアプリケーションを構築できます。

このガイドでは、Squarespace APIと一意のAPIキーの概要を説明します。詳細については、API開発者向けドキュメントをご覧ください。

Zapierに関するヘルプについては、「Zapierとのフォーム統合を追加する」をご覧ください。

Squarespace APIはプレミアム機能です。

• フォームAPI (Zapier統合用) は、BusinessおよびCommerceプランでご利用になれます。
• 注文APIはCommerce Advancedプランでのみ利用できます。
• 在庫APIはCommerce Advancedプランでご利用になれます。
• 取引APIはCommerce Advancedプランでご利用になれます。

APIについて

構築できる内容

SquarespaceのAPIを使用することにより、様々なユースケースで他のソフトウェアとの直接統合を構築できます。フォームAPIキーを作成してZapierとの統合を使用するか、Commerce APIキーを作成してCommerceプランで独自のカスタム ツールを構築します。

APIを通じて当社がアクセスを提供するデータを使用すると、次のことが可能になります。

• サードパーティーのフルフィルメントまたは配送アプリケーションに接続する
• 在庫を他の販売チャネルや在庫管理システムと同期する
• サードパーティーのソフトウェアで注文確認メールを送信する
• 配送ラベルの印刷を自動化する
• 自動会計処理
• Zapier統合に接続する

統合が可能かを確認するには、開発者向けドキュメントをご覧ください。

APIキーのセキュリティ

一意のAPIキーは、Squarespaceアカウントへの認証アクセスを許可するランダム化された文字列です。

新しいキーを作成する方法は以下のとおりです。

1. [開発者ツール] パネルを開きます。
2. [開発者APIキー] をクリックします。
3. [キーを生成] をクリックします。
   
4. キー名を入力します。
5. [権限] で、[注文]、[フォーム]、[在庫]、または [取引] を確認します。フォームはBusinessプラン以上でご利用になれます。注文、在庫、取引はCommerce Advancedプランでのみご利用になれます。
6. APIキーに付与する権限を選択します。
7. [次へ] をクリックします。
8. 一意のAPIキーをコピーします。

このキーを取得したら、以下に従ってください。

• 安全に保管します。APIキーは、様々なアカウントのパスワードと同じように取り扱ってください。
• 記録用にコピーして保存します。セキュリティ上の理由から、Squarespaceではお客様のAPIキーを保存しません。ウィンドウを閉じた時点でAPIキーの再表示はできなくなりますが、紛失した場合はいつでも新しく作成できます。

これらの手順をもう一度実行することにより、複数のキーを作成できます。

Zapier統合

オンライン自動化ツールのZapierに、フォーム ブロック、ニュースレター ブロック、カバー ページ フォームを接続することができます。これにより、自動化ワークフローの一種であるZapの作成が可能になり、フォームの送信を使用して、Slack、Trello、ConvertKit、Salesforceなどを含む他のZapier統合をトリガーすることができます。Squarespaceを便利なツールに接続してプロセスを自動化することにより、時間を節約できます。

ヘルプについては、「Zapierとのフォーム統合を追加する」をご覧ください。

Commerce API

Commerce APIを使用して、ストアの注文、在庫、取引データをサードパーティー サービスと同期します。これは、ビジネスの管理に使用する他のサービスとSquarespaceストアを連携させ、配送や納税申告などの重要なタスクを自動化するための優れた方法です。これらのAPI使用に関する詳細については、開発者向けドキュメントをご覧ください。

• 在庫API - Squarespaceの在庫を在庫管理システムと同期します。
• 注文API - Squarespaceの注文を、配送サービスやフルフィルメント サービスと同期します。注文 (書き込み) APIを使用して、サードパーティーの販売チャネルから注文をインポートすることもできます。
• 商品API - 商品を作成、編集、削除します。
• 取引API - Squarespaceの取引と寄付を会計サービスと同期します。
• WebhookサブスクリプションAPI - Squarespaceサイトからの通知にサブスクリプション登録します。

以下の点に留意してください。

• Commerce APIを使用してサードパーティーの支払い処理業者に接続することはできません。サイトでの注文処理には、販売時点情報管理用のSquare、Stripe、またはPayPalのみを使用できます。
• 注文APIと在庫APIは、販売者が独自のカスタム統合を構築できるように設計されています。Squarespace Extensionsで、サードパーティー サービスによって構築されたSquarespace公式の拡張機能を探してください。

APIキーを取り消す

APIキーを取り消すには、Squarespaceの [外部APIキー] パネルでAPIキーを削除してください。

1. [開発者ツール] パネルを開きます。
2. [開発者APIキー] をクリックします。
3. 取り消すAPIキーの横にあるゴミ箱アイコンをクリックします。
4. [確認] をクリックします。

APIキーを削除すると、そのキーを使用してサイト データにアクセスしているアプリやサービスとサイト間の接続が切断されます。これらのアプリまたはサービスには、APIが接続されている間にお客様が送信したデータが残っている可能性があります。過去のデータを管理するには、開発者に直接お問い合わせください。

トラブルシューティングとサポート

APIキー

APIキーに関する問題のトラブルシューティングを行う場合は、次の手順を最初に行うことをおすすめします。

• 正しいタイプのAPIキーを使用していることをご確認ください。たとえば、フォーム統合の構築に使用できるのはフォームAPIのみです。
• 特定のフォームまたは注文が表示されない場合は、正しいサイトのAPIキーを作成しているかご確認ください。
• Zapierにフォームが表示されず、APIキーが正しいサイトのものである場合は、Squarespaceでフォームを削除して新しいフォームを追加してください。

Commerce API

Squarespace Commerce APIの使用に関するヘルプについては、すべてのパブリックAPIに関する詳細な資料が記載されている開発者サイトをご覧ください。ご不明な点がございましたらお問い合わせください。