Apercu de l'API REST

L'API REST Screenzzie vous permet de gerer programmatiquement vos ecrans d'affichage numerique, playlists, medias et planifications. Parfait pour les integrations, l'automatisation et les applications personnalisees.

URL de base

Tous les endpoints API sont disponibles a :

https://www.screenzzie.com/api/v1

Authentification

L'API utilise l'authentification par jeton Bearer avec des cles API. Incluez votre cle API dans l'en-tete Authorization :

curl -X GET "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_votre_cle_api_ici" \
  -H "Content-Type: application/json"

Obtenir une cle API

Allez dans Parametres > Cles API dans votre tableau de bord Screenzzie
Cliquez sur Creer une cle API
Choisissez un nom descriptif et selectionnez les permissions
Copiez votre cle immediatement (elle n'est affichee qu'une seule fois !)

Gardez votre cle API securisee ! Ne l'exposez jamais dans du code cote client ou des depots publics.

Portees des cles API

Lors de la creation d'une cle API, vous pouvez choisir parmi trois niveaux de permission :

Portee	Permissions
Read	Voir les ecrans, playlists, medias, planifications
Write	Read + Creer, mettre a jour, supprimer des ressources
Admin	Acces complet incluant la gestion des cles API

Limites de debit

Les requetes API sont limitees en debit selon votre plan d'abonnement :

Plan	Requetes par jour
Business	1 000
Growth	100 000
Enterprise	Illimite

Les en-tetes de limite de debit sont inclus dans toutes les reponses :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

Format de reponse

Toutes les reponses sont retournees au format JSON avec une structure coherente :

Reponse de succes

{
  "success": true,
  "data": {
    // Donnees de la ressource ici
  }
}

Reponse paginee

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5,
      "hasMore": true
    }
  }
}

Reponse d'erreur

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Le nom est requis",
    "details": { ... }
  }
}

Codes d'erreur

Code	Description
`UNAUTHORIZED`	Cle API invalide ou manquante
`FORBIDDEN`	Permissions insuffisantes
`NOT_FOUND`	Ressource non trouvee
`VALIDATION_ERROR`	Parametres de requete invalides
`RATE_LIMIT_EXCEEDED`	Trop de requetes
`FEATURE_NOT_AVAILABLE`	Fonctionnalite necessite un plan superieur
`INTERNAL_ERROR`	Erreur serveur

Endpoints disponibles

L'API fournit les ressources suivantes :

Ecrans - Gerez vos ecrans d'affichage numerique
Playlists - Creez et gerez des playlists
Medias - Accedez et enregistrez des fichiers medias
Planifications - Planifiez du contenu (plan Growth)

Prochaines etapes

Consultez la reference des Endpoints API
Creez votre premiere Cle API dans le tableau de bord

Apercu de l'API

docs.apiCtaBanner.title