Skip to main content
StormyCMS
DocsAPIExamples

Frequently Asked Questions

Find answers to common questions about StormyCMS and its API.

General

What is StormyCMS?

StormyCMS is a headless content management system that provides a powerful GraphQL API for managing your content. It allows you to create, update, and manage pages, layouts, and components through a flexible API.

How is StormyCMS different from other CMS platforms?

StormyCMS is API-first, meaning all content management happens through our GraphQL API. This makes it perfect for:

  • Jamstack applications
  • Static site generators
  • Modern web frameworks (React, Vue, Angular, etc.)
  • Custom frontend implementations

What can I build with StormyCMS?

You can build any type of website or application:

  • Blogs and news sites
  • E-commerce platforms
  • Corporate websites
  • Documentation sites
  • Landing pages
  • Mobile app backends

Getting Started

How do I sign up for StormyCMS?

  1. Visit stormycms.com
  2. Click "Sign Up"
  3. Create your account with email and password
  4. Verify your email address
  5. Log in to your dashboard

What do I get after signing up?

After signing up, you can:

  • Create multiple sites
  • Generate API keys for each site
  • Manage your content through the dashboard
  • Access our GraphQL API

How do I create a new site?

  1. Log in to your dashboard
  2. Click "Create New Site"
  3. Enter your site name and select settings
  4. Click "Create Site"
  5. Navigate to Settings → API Keys to get your credentials

API & Authentication

What's the difference between Client ID and API Key?

  • Client ID: A public identifier for your site. It's safe to share and can be used in client-side code.
  • Site API Key: A secret key that authenticates your requests. Never expose this in client-side code or public repositories.

How do I authenticate API requests?

Include these headers in every request:

headers: {
  'Content-Type': 'application/json',
  'x-site-api-key': 'YOUR_SITE_API_KEY',
  'x-client-id': 'YOUR_CLIENT_ID'
}

Can I use the API from the browser?

Yes, but be careful:

  • Never expose your Site API Key in public client-side code
  • Use environment variables or server-side endpoints for sensitive operations
  • Consider using a backend proxy for production applications

What are the rate limits?

  • Site API Keys: 10,000 requests per hour per key
  • Rate limit headers are included in responses:
    • X-RateLimit-Limit: Maximum requests per hour
    • X-RateLimit-Remaining: Remaining requests
    • X-RateLimit-Reset: When the limit resets

Content Management

What are pages?

Pages are the main content containers in StormyCMS. Each page has:

  • Metadata (title, description, keywords)
  • Associated layout
  • Components that make up the content

What are layouts?

Layouts define the structure and appearance of your pages. They can include:

  • Header and footer sections
  • Navigation components
  • Content areas
  • Reusable design patterns

What are components?

Components are the building blocks of your content. They can be:

  • Text blocks
  • Images
  • Forms
  • Custom interactive elements
  • Nested components

Can I create custom components?

Yes! Components are flexible and can include:

  • Custom properties
  • Translated content
  • Child components
  • Any data structure you need

Technical

What GraphQL client libraries do you recommend?

Popular options include:

  • JavaScript: graphql-request, apollo-client, urql
  • React: @apollo/client, urql
  • Vue: @apollo/client, vue-apollo
  • Angular: apollo-angular
  • Node.js: graphql-request, apollo-client

Do you have SDKs?

We provide examples and client implementations in our Examples section. While we don't maintain official SDKs, our GraphQL API works with any standard GraphQL client.

Can I use StormyCMS with static site generators?

Absolutely! StormyCMS is perfect for:

  • Next.js (getStaticProps, getServerSideProps)
  • Gatsby (source plugin)
  • Hugo, Jekyll, Eleventy (via API)
  • Custom build processes

How do I handle images and media?

Currently, images and media are handled through:

  • URL references in component properties
  • CDN integration for optimized delivery
  • Base64 encoding for small assets
  • We're working on native media management features

Troubleshooting

I'm getting a 401 Unauthorized error

Check that:

  • Your API key is correct
  • Your client ID is correct
  • Both headers are included in the request
  • Your API key hasn't been revoked

I'm getting a 403 Forbidden error

This usually means:

  • You don't have permission for the operation
  • You're trying to access another site's data
  • Your account needs to be upgraded

I'm getting a 429 Too Many Requests error

You've hit the rate limit. Solutions:

  • Wait for the limit to reset (check X-RateLimit-Reset header)
  • Implement caching in your application
  • Optimize your queries to fetch less data
  • Consider upgrading your plan for higher limits

My mutations are failing

Common issues:

  • Missing required fields
  • Invalid data format
  • Insufficient permissions
  • Referencing non-existent resources

GraphQL query returns null

Check for:

  • Valid GraphQL syntax
  • Correct field names
  • Proper variable types
  • Authentication headers

Billing & Plans

Is StormyCMS free?

We offer a free tier with:

  • 1 site
  • Basic features
  • Standard rate limits
  • Community support

Paid plans include:

  • Multiple sites
  • Higher rate limits
  • Additional features
  • Priority support

How do I upgrade my plan?

  1. Log in to your dashboard
  2. Go to Billing → Plans
  3. Select your desired plan
  4. Enter payment information
  5. Confirm upgrade

Can I change my plan later?

Yes! You can upgrade or downgrade your plan at any time. Changes take effect at the next billing cycle.

Security

How secure is my data?

We implement:

  • HTTPS for all communications
  • Encrypted data storage
  • Regular security audits
  • GDPR compliance
  • SOC 2 Type II certification

Should I use environment variables for API keys?

Yes! Always store sensitive credentials in environment variables:

.env
STORMYCMS_API_KEY=sk_site_your_key_here
STORMYCMS_CLIENT_ID=your_client_id_here

What about CORS?

CORS is configured to allow requests from:

  • Your registered domains
  • Localhost for development
  • Custom domains you specify

Support

How do I get help?

Do you offer technical support?

  • Free tier: Community support
  • Pro plans: Email support (48-hour response)
  • Enterprise: Dedicated support, SLA

How do I report bugs or request features?

  1. Check if it's already reported
  2. Create an issue on GitHub
  3. Include:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details

Still have questions?

Can't find what you're looking for? We're here to help:

  • Email: support@stormycms.com
  • Documentation: Full documentation at stormycms.com/docs
  • Community: Join our Discord community
  • Status: Check our status page at status.stormycms.com

Last updated: January 2024

Last updated: 2/27/26, 3:48 AM

StormyCMSPowerful Headless CMS with GraphQL API
Community
githubdiscordStormyCMS