# API best practices

The Quable Team
Published 2023-11-01

# Choice Guide: API Import vs .csv files

# API Import

# Pros

  • Automation: Data transfers are fully automated, offering near-real-time synchronization.
  • Enhanced Security: API calls are secure, ensuring data protection during transfer.
  • Performance Optimization: Selective sending of updated data reduces load and bandwidth.

# Cons

  • Technical Requirements: Skills required for initial setup.
  • Import Time: For large volumes, import time may be longer than CSV.

# CSV File Import

# Pros

  • Import Speed: Particularly fast for large volumes.
  • Flexibility: On-demand or scheduled import options.
  • Pre-Import Validation: Ability to check CSV before import.
  • Import Reports: Viewing and downloading from the PIM interface.

# Cons

  • Not Always Real-Time: Delays may occur with scheduled imports.

# Tips for Choosing

Consider the following to choose your import method:

  1. Nature and Frequency of the updates: API is ideal for frequent and immediate updates. For less frequent updates or large volumes, .csv is preferable.
  2. Technical Resources: Evaluate the internal available skills in your company to determine the best option.
  3. Long-Term Vision: Anticipate the evolution of your needs to choose the best solution.
Characteristic API CSV
Automation yes Partial (scheduled imports)
Security yes (Secure Calls) Depends on transfer method
Speed for Large Volumes Slower Very Fast
Flexibility Selective data sending On-demand or scheduled import
Validation Not before sending Before import
Import Reports None (unless specified) yes (Viewable and downloadable)
Technical Requirements Higher Lower

# API limitations

View more details on this page.