How to Create and Manage Squarespace API Keys for Site Integration

How to Create and Manage Squarespace API Keys for Site Integration

By Michael Thompson

January 23, 2025 at 06:49 PM

An API key is a unique identifier that allows secure connections between your Squarespace site and third-party integrations. Here's what you need to know about Squarespace API keys and their functionality.

API Availability by Plan:

  • Forms API: Core, Plus, Advanced, Business, Commerce Basic, and Commerce Advanced plans
  • Orders API: Core, Plus, Advanced, and Commerce Advanced plans
  • Inventory API: Core, Plus, Advanced, and Commerce Advanced plans
  • Transactions API: Core, Plus, Advanced, and Commerce Advanced plans

Common API Uses:

  • Connect to third-party fulfillment services
  • Sync inventory across sales channels
  • Automate shipping labels and accounting
  • Send order confirmations via external software
  • Enable Zapier integrations for forms
  • Manage product inventory

Creating an API Key:

  1. Access Developer tools panel
  2. Click Developer API Keys
  3. Select Generate Key
  4. Enter Key Name
  5. Choose Permissions (Orders, Forms, Inventory, or Transactions)
  6. Click Next
  7. Copy and save your unique key immediately

Security Best Practices:

  • Store your API key securely
  • Save a backup copy of the key
  • Create multiple keys for different integrations
  • Never share your key publicly

Commerce API Features:

  • Inventory API: Sync with management systems
  • Orders API: Connect with shipping services
  • Products API: Manage product listings
  • Transaction API: Interface with accounting services
  • Webhook subscriptions API: Receive site notifications

Revoking an API Key:

  1. Open Developer tools panel
  2. Click Developer API Keys
  3. Click the trash icon next to the key
  4. Confirm deletion

Note: Deleting a key immediately terminates the connection with associated services. Historical data may remain in third-party applications.

Troubleshooting Tips:

  • Verify the correct API key type for your integration
  • Ensure the key is generated for the right site
  • For form issues in Zapier, try recreating the form
  • Check plan compatibility for specific API features

Limitations:

  • Cannot connect third-party payment processors
  • Only supports Square POS, Stripe, and PayPal for processing orders
  • Some features require specific subscription plans

For detailed technical documentation and implementation guides, refer to the Squarespace Developer Site.

Related Articles

Previous Articles