https://gateway.streamfizz.live/apiConfigure l'inscription des spectateurs d'un média. Le premier appel crée la configuration, publique par défaut ; ensuite, les arguments absents ou à null restent inchangés.
Renvoie le média : la configuration se lit dans privacy.
| Nom | Type | Description |
|---|---|---|
id* | ID! | Média à configurer. |
type | PrivacyType |
|
allowDirectRegister | Boolean | Inscription ouverte ( |
allowPreviewContent | Boolean | Montre le titre et la vignette du contenu sur la page d'inscription. Défaut à la création : |
allowMultiSession | Boolean | Autorise un spectateur à regarder depuis plusieurs appareils à la fois. Sinon, une nouvelle connexion ferme la précédente sur ce contenu. Défaut à la création : |
allowSocialLogin | Boolean | Propose la connexion avec Google ou LinkedIn. Défaut à la création : |
allowedDomains | [String!] | Domaines d'e-mail autorisés, invités compris. Remplace la liste ; une liste vide autorise tous les domaines. Chaque domaine est mis en minuscules, sans |
fields | [InscriptionFieldInput!] | Champs demandés à l'inscription, dans l'ordre d'affichage. Remplace la liste. Le libellé |
Media| Nom | Type | Description |
|---|---|---|
id | ID! | Identifiant unique du média. |
title | String | Titre du média. |
type | MediaType | Type de média. |
sourceKey | String | Clé S3 du fichier source original. |
fileName | String! | Nom du fichier source. Pour un média créé par l'API depuis une URL, c'est
le dernier segment de l'URL normalisé : minuscules, espaces et caractères
spéciaux remplacés par des tirets ( |
cote | String | Cote ou référence métier interne. |
note | String | Note interne sur le média. |
myCapability | AuthzCapability! | Ce que l'appelant a le droit de faire sur ce contenu, compte tenu de ses
groupes et de ses accès directs : |
encodingVersion | String | Version actuelle d'encodage (ex: "v0", "v2.1"). |
isEncoding | Boolean! | Un encodage de la version courante est en cours. Faux pour un média sans encodage lancé (créé sans fichier) ou en version v0. |
duration | Float | Durée du média en secondes. Vaut 0 tant que l'encodage ne l'a pas mesurée. |
ratio | Float | Ratio d'aspect (largeur / hauteur). |
playlistKey | String | Clé S3 de la playlist HLS. |
playlistCdnUrl | String | URL CDN de la playlist HLS. |
thumbKeys | [String] | Clés S3 des miniatures générées. |
thumbCdnUrls | [String] | URLs CDN des miniatures générées. |
selectedThumbKey | String | Clé S3 de la miniature sélectionnée. |
selectedThumbCdnUrl | String | URL CDN de la miniature sélectionnée. |
thumbnailVttCdnUrl | String | URL CDN du fichier VTT des vignettes de prévisualisation. |
deltaChapter | Int | Décalage en secondes appliqué aux points de chapitre à la lecture, pour rattraper la latence d'encodage et de diffusion. |
publicUrl | String | URL de la page de lecture publique. |
publicEmbedUrl | String | URL d'intégration (embed) publique. |
publisher | User! | Utilisateur ayant publié le média. |
account | Account | Compte propriétaire du média. |
accessGroups | [Group!]! | - |
directUsers | [PublicUser!]! | - |
createdAt | DateTime! | Date de création du média. |
updatedAt | DateTime! | Date de dernière modification du média. |
encoding | Encoding! | État d'encodage de la version servie. |
pendingEncoding | Encoding | Ré-encodage en cours, s'il y en a un : il remplacera la version servie une fois terminé. Null sinon. |
mediaInfos | Json | Infos techniques d'encodage (ffprobe-like pour v1+, array typé pour v0 legacy). |
subtitles | [Subtitle!] | Sous-titres associés au média. |
files | [File!] | Fichiers joints au média. |
chapters | [Chapter] | Chapitres associés au média. |
clips | [Clip!] | Clips dérivés du média. |
live | Live | Live associé si ce média est un replay. |
discussion | Discussion | Discussion (chat) associée au média. |
moderatorContents | [ModeratorContent] | Modérateurs désignés pour ce média. |
relatedTags | [Tag] | Tags rattachés. |
relatedCategories | [Category] | Catégories rattachées. |
pageSetting | BrandSetting | Paramètres de personnalisation de la page de lecture. |
embedSetting | BrandSetting | Paramètres de personnalisation de l'embed. |
preRoll | RollPreset | Annonce intro associée. |
postRoll | RollPreset | Annonce outro associée. |
seo | SEO | Paramètres SEO de la page de lecture. |
confidentiality | Confidentiality | Niveau de confidentialité (nouveau modèle). |
privacy | Privacy | Inscription des spectateurs. |
playlists | PlaylistConnection | Playlists contenant ce média. |
webTVs | WebTVConnection | WebTVs contenant ce média. |
metadata | MediaMetadata | Métadonnées descriptives (production, auteur, contenu). |
originalPublisher | DeletedUser | - |
| Code | Message | Description |
|---|---|---|
UNAUTHENTICATED | Invalid or expired API key | Clé API manquante ( |
API_ADDON_REQUIRED | This account does not have the API addon | La clé est valide mais le compte n'a pas l'option API. La réponse porte un code HTTP 403 ; la requête n'est pas exécutée. |
INPUT_VALIDATION_ERROR | Validation failed: {field}: {message} | Un ou plusieurs champs sont invalides (format, longueur, protocole…). Le détail est dans extensions.fieldErrors[]. Tout argument texte qui n'est pas de l'Unicode valide — caractère NUL ( |
GRAPHQL_VALIDATION_FAILED | Query depth limit of 10 exceeded, found {depth}. | Le document ne respecte pas le schéma : champ ou argument inconnu, valeur écrite en dur dans la requête qui n'a pas le type attendu (valeur d'enum inexistante…), ou limite par requête dépassée (profondeur, coût, alias, directives — voir Rate Limiting). La réponse porte un code HTTP 400 ; rien n'est exécuté. |
BAD_USER_INPUT | Variable "$name" got invalid value {value}; {reason} | Une variable ( |
INTERNAL_SERVER_ERROR | Internal server error | Erreur interne du serveur. Le message est volontairement générique : le détail est journalisé côté Streamfizz, jamais renvoyé. |
| Code | Message | Description |
|---|---|---|
NOT_FOUND | {Type} '{id}' has not been found | L' |
FORBIDDEN | You don't have the permission for this request | Le contenu appartient à un autre compte, ou l'utilisateur de la clé n'a pas le droit d'écriture sur lui. Pour une clé qui n'est ni propriétaire ni administrateur du compte, un identifiant inconnu donne aussi cette erreur. |
INPUT_VALIDATION_ERROR | Validation failed: allowedDomains.{index}: Invalid domain | Une entrée de |
Validation failed: fields: Duplicate form label | Un même | |
Validation failed: fields: Unknown form label | Un | |
Validation failed: {field}: Too big: expected array to have <={max} items |
|
60 requêtes par minute par clé API
En cas de dépassement, une erreur 429 Too Many Requests est retournée.