Aller au contenu

Conventions de l’API

  • URL de base : https://api.getripa.com/api/platform/v1 (production) et https://api-dev.getripa.com/api/platform/v1 (test).
  • Les requêtes et les réponses sont en JSON, avec des noms de champs en snake_case. Un champ sans valeur est absent de la réponse, il n’est pas envoyé à null.
  • Les dates et heures sont des instants ISO-8601 en UTC (2026-11-05T08:12:41Z). Les montants sont des nombres JSON. Ne faites jamais transiter un montant par un type à virgule flottante binaire dans votre propre code.
  • Un succès a la forme { "object": "...", "data": ..., "meta": { "request_id": "..." } }. Une liste ajoute "pagination": { "limit", "has_more", "next_cursor" } : renvoyez next_cursor dans cursor pour obtenir la page suivante.
  • Une erreur a la forme { "object": "error", "error": { "code", "message", "type", ... }, "meta": { "request_id": "..." } }. Le code est stable : c’est lui que votre code doit lire. Le message est en français, écrit pour pouvoir être transmis à votre client. Citez meta.request_id quand vous nous écrivez.
  • La version 1 est figée dès que la première plateforme est en service : nous n’y ajoutons plus que des champs, des routes et des valeurs d’énumération. Une rupture serait une version 2 à côté de la 1. Ignorez les champs que vous ne connaissez pas, et acceptez les valeurs d’énumération que vous ne connaissez pas (un nouvel origin, type, state ou reason_code) : journalisez-les et continuez, sans jamais échouer dessus.