Import your Data with our API
1.1 Getting Started with API Integration
Your Journey
Your Technical Account Manager will guide you through the entire API integration process, providing bearer tokens for both sandbox (testing) and production environments. They'll support you from the initial kick-off meeting all the way through data mapping, setting up connections (whether done internally or with a partner integrator), testing, and finally the production launch.
💡 Need Help? Contact your Technical Account Manager:
- Clotilde Bazin - clotilde.bazin@fairlymade.com
- Guillaume Babule - guillaume.babule@fairlymade.com
Depending on your organization's needs and IT availability, you can choose from three support levels during the API setup phase.
👉 For more details, book a meeting with your Technical Account Manager here.
1.2 Technical Implementation Requirements
Data Import Sequence
Follow this mandatory order when creating your data:
Packaging (optional) → Suppliers → Products → Components
This sequence ensures proper data relationships and prevents import errors.
System Identifiers
Understanding how the system identifies your data is crucial:
- Products: Uniquely identified by combining
productRef+productCollectionRef+productColorCode - Components: Uniquely identified by
componentRef(ensure uniqueness across categories/seasons by concatenating additional fields if needed)
API Call Requirements
Every API call must include your :
- Bearer token (a secure key that acts as your unique "password" to authorize system access). To retrieve it, access the platform, go to My Account, then Token API tab or ask your IT referent,
- Importation Batch code (to identify specific data batches)
- and Project Type (matching your Fairly Made contract, e.g., Standard or AGEC).
Respect rate limits of 150 requests per second and wait 2-5 seconds between creating different object types.
Environment Management
Work with two separate environments:
- Sandbox for testing (initially empty, populated with your test data)
- and Production for live data.
Each environment has its own bearer token.
1.3 Testing and Documentation
Using Postman for Testing
You can test your API implementation using Postman before going live. Refer to the Postman documentation for setup instructions.
Test Sets
To better understand the expected data for each endpoint, you can access test datasets on this link. These examples will guide you in structuring your API calls correctly.
You can either download our Postman test collections to import directly into your Postman app for hands-on testing, or review our JSON sample files for reference.
API Documentation Access
Access comprehensive technical documentation here. The documentation provides sample payloads, and real-world scenarios for all endpoints, helping you structure API calls correctly.