Introduction
Welcome to the Faire Developer Platform.
Our APIs provide developers with robust tools necessary to build innovative solutions for our marketplace. This document outlines the policies governing the use of Faire's APIs, including details on versioning, deprecations, compatibility, and general usage guidelines. Your use of Faire’s API is governed by Faire’s API License Agreement, and in the event of any conflict between this API Policy and the API License Agreement, the API License Agreement controls.
API Versioning
Version Format
Our API versions use semantic versioning: v1, v2, etc. Clients choose the version of the endpoint to use via the URL path.
Stable Channel
We provide a stable channel of our APIs, ensuring backward compatibility for endpoints in this channel for at least 12 months after their release according to the Deprecation Policy below. We will communicate any deprecation plans at least 12 months in advance to provide ample time for migration, absent exceptional circumstances.
Beta Channel
Occasionally, we release beta versions of endpoints to gather feedback and make adjustments before a full stable release. Beta versions are subject to change and may not be backwards compatible. Use of beta APIs in production environments is discouraged.
Compatibility
Our APIs are designed to ensure forward compatibility within a stable version. Backwards compatible updates like adding new fields will not require version changes, ensuring that your integration remains stable over time.
Deprecation Policy
Notification
Developers will receive deprecation notifications via email and developer portal announcements 12 months in advance.
Sunset Period
When Faire announces a backwards-incompatible change to an API, Faire releases a new major version of the affected API endpoint in parallel with the old version so that both endpoints are available and live for clients to use for a period of 12 months.
Migration Support
We provide comprehensive documentation and dedicated support to assist developers in migrating to newer API versions.
Exceptions
In exceptional circumstances requiring urgent changes, Faire reserves the right to expedite the deprecation process without adhering to the standard 12-month timeline.
Usage Guidelines
- Rate Limits: To ensure service reliability, rate limits are applied to API requests. We recommend all developers actively monitor for HTTP 4xx errors.
- Security: All API requests must be made over HTTPS. Ensure your API keys are kept confidential and not exposed in public repositories or client-side code.
- Data Privacy: Adhere to all relevant data protection regulations when using our APIs, particularly when handling personal or sensitive information.
Changes to API Policy
We reserve the right to update or modify this policy at any time. Changes to the policy will be communicated through the developer portal and/or direct communication to registered developers.
Contact Information
For any questions or concerns regarding our API policy or for technical support, please contact our support team at integrations.support@faire.com.