Aller au contenu principal

API PlayLoop Campaigns

Objectif​

Créer, lister et terminer des campagnes PlayLoop ciblant des écrans ou playlists.

Périmètre​

Campagnes d’affichage local, périodes de diffusion, médias et statistiques éventuelles.

Acteurs/applications consommatrices​

  • Interface PlayLoop admin.
  • API Laravel.
  • Devices via synchronisation playlist/campagne.

Authentification requise​

Routes visibles : identify.app + auth:sanctum, avec X-App-Source: playloop.

Permissions/RBAC​

  • Ciblage limité au périmètre acteur/compte autorisé.
  • Campagnes payantes ou boostées validées côté Laravel.
  • IA assistante uniquement, validation humaine requise.

Endpoints actuels visibles si confirmés​

MéthodeRouteStatut
GET/api/v1/playloop/acteurs/{id}/campaignsConfirmé.
POST/api/v1/playloop/acteurs/{id}/campaignsConfirmé.
PATCH/api/v1/playloop/campaigns/{id}/endConfirmé.

Endpoints cibles proposés si utile​

  • PATCH /api/v1/playloop/campaigns/{id} pour édition, non confirmé.
  • POST /api/v1/playloop/campaigns/{id}/pause, non confirmé.
  • GET /api/v1/playloop/campaigns/{id}/stats, non confirmé.

Exemple de requête​

POST /api/v1/playloop/acteurs/acteur-id/campaigns
Authorization: Bearer <token>
X-App-Source: playloop
Content-Type: application/json

{
  "playlist_id": "playlist-uuid",
  "starts_at": "2026-05-10T10:00:00Z",
  "ends_at": "2026-05-17T10:00:00Z",
  "status": "draft"
}

Exemple de réponse succès​

{
  "campaign": {
    "id": "campaign-id",
    "status": "draft"
  }
}

Exemple d’erreur​

{
  "error": "campaign_invalid_period",
  "message": "La période de campagne est invalide."
}

Pagination si applicable​

Applicable à la liste des campagnes.

Rate limiting si applicable​

Recommandé sur création et génération assistée IA future.

Audit/logs si applicable​

Obligatoire pour création, fin anticipée, changement de ciblage et campagnes payantes.

Sécurité​

  • Validation des contenus avant diffusion.
  • Contrôle du périmètre devices/playlists.
  • Pas de diffusion automatique de contenu IA sans validation humaine.

État actuel vs cible​

SujetÉtat actuelCible
CampagnesRoutes visibles.Statuts, édition, stats et priorités à stabiliser.
IA PlayLoopVision documentée.Génération assistée contrôlée.

Points à confirmer​

  • Statuts confirmés : draft, active, ended.
  • Priorités entre campagnes.
  • Statistiques disponibles.
  • Modèle économique associé.