Application Programming Interface (API) keys enable developers to build integrations between your Squarespace site and other applications. Here's a comprehensive guide on using Squarespace API keys effectively.

API Availability By Plan:

• Forms API: Available on Core, Plus, Advanced, Business, and all Commerce plans
• Orders API: Available on Core, Plus, Advanced, and Commerce Advanced plans
• Inventory API: Available on Core, Plus, Advanced, and Commerce Advanced plans
• Transactions API: Available on Core, Plus, Advanced, and Commerce Advanced plans

Creating an API Key:

1. Navigate to Developer tools panel
2. Click "Developer API Keys"
3. Click "Generate Key"
4. Enter Key Name
5. Select required permissions (Orders, Forms, Inventory, or Transactions)
6. Click Next
7. Copy and save your unique API key securely

API Security Best Practices:

• Store your API key securely
• Never share your key publicly
• Save a backup copy (keys cannot be retrieved later)
• Create multiple keys for different integrations

Available API Functions:

• Forms API: Connect with Zapier for workflow automation
• Inventory API: Sync inventory with management systems
• Orders API: Integrate with shipping and fulfillment services
• Products API: Manage product creation and editing
• Transaction API: Connect with accounting services
• Webhook API: Set up site notifications

Revoking an API Key:

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

Note: Deleting a key immediately breaks the connection with associated services.

Troubleshooting Tips:

• Verify you're using the correct API key type
• Confirm the API key is created for the right site
• For form issues in Zapier, try deleting and recreating the form

Important Limitations:

• Cannot connect third-party payment processors
• Only supports Square, Stripe, and PayPal for payment processing
• Commerce APIs are designed for custom integrations

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

Related Articles

Previous Articles