> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/support-and-resources.md). # Support and Resources ### Getting Help #### Technical Support If you encounter issues or have questions about the API: **Email:** **Response Time:** Typically within 24 hours on business days **When contacting support, include:** * Error codes and full error messages * Example requests (excluding API keys) * Timestamps when errors occurred * Expected vs. actual behavior * Steps to reproduce the issue #### Other Feedback You can also submit any other feedback. This is useful for: * Feature requests * API improvement suggestions * Documentation feedback * Usability issues *** ### Resources #### API Reference For complete endpoint documentation with request/response examples, see the api references: * [Customer API Reference](/development/api-reference-app.md) * [Provider API Reference](/development/api-reference-pro.md) #### Release Notes Stay informed about API updates, new features, and bug fixes: [Release Notes](https://hub.equipme.io/release-updates/) #### Status Page Check the current operational status of our platform: [Status Page](https://status.equipme.io/) #### Account Management Manage API keys and tenant settings: * **Customers:** Settings → Integrations → API-Key * **Suppliers:** Pro → Integrations → API Key *** ### Developer FAQ #### General Questions **Q: Are there different API access levels?** A: Currently, all API keys have full administrative access to endpoints available for your tenant type. Granular permissions are planned for the future. **Q: Can I use multiple API keys?** A: Yes, you can create and use multiple API keys simultaneously. This is useful for separating different integrations or environments. **Q: How do I test my integration without affecting production data?** A: Currently, we don't offer a separate sandbox environment. We recommend testing with a dedicated test tenant if possible. You can register new customer or provider with a trial period at any time. If you need extended testing periods, contact us. *** #### Authentication **Q: How long are API keys valid?** A: API keys are valid indefinitely by default, unless you set an expiration date during creation. Keys with expiration dates will stop working after the specified date. **Q: What happens if I lose my API key?** A: For security reasons, API keys are only displayed once during creation. If you lose a key, you must generate a new one and update your integration. **Q: Can I rotate API keys without downtime?** A: Yes. Generate a new key, update your integration to use it, test thoroughly, then delete the old key. **Q: Do API keys work across all environments?** A: API keys are environment-specific. A production key won't work in development environments and vice versa. *** #### Data & Resources **Q: What timezone are dates in?** A: All dates and timestamps are in UTC (ISO 8601 format with `Z` suffix). **Q: Are there limits on how much data I can retrieve?** A: Pagination limits vary by endpoint (typically max 1000 items per page). Use pagination to retrieve larger datasets across multiple requests. *** #### Errors & Troubleshooting **Q: Why am I getting 404 for a resource I know exists?** A: 404 can mean either the resource doesn't exist OR you don't have access to it. Verify the resource ID and check that your tenant has permission to access it. **Q: What should I do about intermittent 5xx errors?** A: Server errors (5xx) are typically transient. Implement retry logic with exponential backoff. If errors persist, check our status page or contact support. **Q: My integration worked yesterday but fails today with 401. What happened?** A: Your API key may have expired. Check the expiration date in the API key management interface and generate a new key if needed. *** #### Integration Patterns **Q: Should I fetch full resource details or use list endpoints?** A: List endpoints often contain sufficient data for most use cases. Only fetch full details when you need additional information not available in the list response. **Q: How do I sync data between your platform and my system?** A: Use incremental polling with date filters. Store the last sync timestamp, then query with `updatedAfter` to fetch only changed resources since your last sync. **Q: Can I make requests in parallel?** A: Yes, you can make parallel requests for independent resources. Be mindful of rate limits - they still apply to parallel requests. **Q: What are the rate limits?** A: POST requests are limited to 100 per second. All other requests are limited to 1000 per minute. Limits apply per unique endpoint path. **Q: What's the best way to handle bulk operations?** A: Implement request queuing to respect rate limits. Process items in batches with appropriate delays, and track successes/failures separately. *** #### Webhooks & Real-time Updates **Q: Do you support webhooks?** A: Webhooks are not currently available but are planned for future development. Currently, use polling with date filters for near-real-time updates. *** #### Migration & Compatibility **Q: Will my integration break when you add new features?** A: No. We're committed to backward compatibility. New features are added in a non-breaking way (new optional fields, new endpoints). Your integration should ignore unknown fields. **Q: What happens to deprecated endpoints?** A: Deprecated endpoints continue to work but are not recommended for new integrations. We provide ample notice before removing any functionality. **Q: How will I know about API changes?** A: API changes are documented in our release notes. We recommend subscribing to updates to stay informed. *** #### Feature Requests **Q: Can you add support for \[specific feature]?** A: We actively develop our API based on customer feedback. Contact support to share your requirements. **Q: When will \[planned feature] be available?** A: We don't provide specific timelines for upcoming features. Check our release notes regularly for announcements about new functionality. *** ### Still Have Questions? If your question isn't answered here: 1. Check the API Reference for endpoint-specific documentation 2. Review the relevant sections of this documentation 3. Use the integrated AI assistant 4. Contact our support team We're here to help you build successful integrations! --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://hub.equipme.io/development/support-and-resources.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.