FAQ
Frequently asked questions about the MyOpcs API. Find answers to common questions about authentication, usage, limits, and best practices.
Getting Started
How do I get an API key?
API keys are available to all users, including free tier users. You can generate API keys from your Dashboard Settings page. Go to Settings → API Keys → Create New Key.
Is the API free to use?
Yes! The API is free for all users. Free tier users can access the API with the same rate limits as paid users (100 requests/minute, 10,000 requests/day). The only difference between tiers is the number of products you can manage.
What is the difference between product ID and slug?
The product ID (e.g., `prod_abc123`) is a unique identifier generated by the system. The slug is a URL-friendly identifier you can customize (e.g., `my-saas-app`). Both can be used interchangeably in API endpoints that accept `:id_or_slug`.
API Usage
Why don't some resources have update (PATCH) endpoints?
We intentionally limit certain operations to encourage using the dashboard for interactive work. For example, versions and logs are meant to be immutable records—once created, they shouldn't be modified. This ensures data integrity and accurate historical tracking.
Can I delete data via the API?
Some resources support DELETE (logs, feedback, tasks), while others don't (versions). We believe certain data should be preserved for audit purposes. If you need to remove sensitive data, contact support.
How do I handle pagination?
List endpoints that support pagination return a `pagination` object with `page`, `pageSize`, `total`, and `totalPages`. Use the `page` and `pageSize` query parameters to navigate through results.
What date formats does the API accept?
The API accepts dates in ISO 8601 format (`YYYY-MM-DD` for dates, `YYYY-MM-DDTHH:mm:ssZ` for timestamps). For example: `2024-01-15` or `2024-01-15T10:30:00Z`.
Data & Limits
What are the rate limits?
Current rate limits are 100 requests per minute and 10,000 requests per day per API key. All responses include rate limit headers (`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`) to help you track usage.
Is there a maximum page size?
Yes, the maximum `pageSize` is 100 for all paginated endpoints. If you need to retrieve more data, use pagination to fetch results in batches.
How long is historical data retained?
On the Standard plan, all historical data is retained indefinitely. The free tier retains the most recent 3 months of data.
Integration
Can I use the API for CI/CD automation?
Yes! The API is designed with automation in mind. Common CI/CD use cases include: creating version records after deployment, logging deployment activities, and syncing metrics from your monitoring tools.
Can I import data from other tools?
Yes, you can use the create endpoints to import data from external sources. Common imports include: revenue data from Stripe/Paddle, feedback from GitHub Issues, and metrics from your analytics tools.
Is there an SDK available?
Not yet. The API is designed to be simple enough to use with standard HTTP clients. We may release official SDKs in the future based on user demand.
Security
How should I store my API key?
Treat your API key like a password. Store it in environment variables (e.g., `MYOPCS_API_KEY`), never commit it to version control, and avoid exposing it in client-side code.
Can I restrict what an API key can do?
Currently, API keys have full access to all resources within your account. Scoped API keys (read-only, specific resources only) are on our roadmap.
What should I do if my API key is compromised?
Immediately revoke the compromised key from your Dashboard Settings and generate a new one. Review your API usage logs for any unauthorized activity.
Still have questions?