Search
K

Switch from French CAAS API V3 to V4

Status: Live 🟢 Market: 🇫🇷

Executive Summary

  • Goal: Switch from CAAS V3 to V4.
  • Value Proposition: In V4, pictures are embedded in the classified JSON. Which makes the picture handling easier.
  • Ideal for: Editors that are using CAAS V3.

The Integration Workflow

Step 1: Branch your developments on V4

Step 2: Stop using removed endpoints

  • Logic: Following endpoints have been removed from our API.
    • POST /classifieds/{classifiedId}/media
    • PATCH /classifieds/{classifiedId}/media/{mediaId}
    • DELETE /classifieds/{classifiedId}/media/{mediaId}
    • DELETE /classifieds/{classifiedId}/media
    • GET /classifieds/{classifiedId}/media
    • PATCH /classifieds/{classifiedId}

Step 3: Code changes for media

  • Location: A new Media node is available at the root level of a classified. ie the same level as portals.
  • Change:
    • It is an array of media items.
    • These media items are the same as in V3. All attributes remain the same apart from displayOrder which has been removed.
  • Logic: Display order is now implicitly taken from the order of the list.

Step 4: Send a stable media update

  • Logic: Please, consider sending us a consolidated update of a classified and its media.
    • As users may change several pictures, send us a unique API call that will sum up all these changes at once.
    • If no media has changed then retain from sending us an update.

Step 5: Operational V3-V4 switch

  • Phase 1:
    • Required: V4 developments done.
    • Goal: Test your developments on our dedicated V4 sandbox.
    • Validation: Both editor and SeLoger give their GO Live. Examples:
      • Adding, removing and ordering several media are OK
      • An update can contain both description and media updates at once
  • Phase 2:
    • Required: list of pilot customers.
    • Goal: Make sure all is OK before scaling.
    • Milestones:
      • Editor switches to V4 for pilot customers
      • Editor stops sending V3 calls.
      • Editor sends V4 updates for all active classifieds of all pilot customers at once.
      • AVIV checks that:
        • All classifieds have same amount of media
        • All classifieds have received a V4 update
      • AVIV removes V3 authorization for these pilot customers
    • Validation:
      • All the above is checked
      • A period of a one-week span is observed.
  • Phase 3:
    • Required: all the above
    • Goal: Switch all remaining customers
    • Milestones: same as phase 2.