https://gateway.streamfizz.live/apiConfigure l'inscription des spectateurs d'une WebTV. Le premier appel crée la configuration, publique par défaut ; ensuite, les arguments absents ou à null restent inchangés.
Renvoie la WebTV : la configuration se lit dans privacy.
| Nom | Type | Description |
|---|---|---|
id* | ID! | WebTV à 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é |
WebTV| Nom | Type | Description |
|---|---|---|
id | ID! | - |
title | String | Nom de la WebTV dans l'espace de gestion. N'apparaît pas sur le site public, où le titre affiché est celui de la page d'accueil. |
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 : |
domain | String | - |
contentCount | Int! | Nombre de contenus rattachés à la WebTV, toutes sections confondues. |
rollOption | WebTVRollOption | - |
note | String | - |
bannerKey | String | - |
bannerCdnUrl | String | - |
publicUrl | String | - |
originalPublisher | DeletedUser | - |
accessGroups | [Group!]! | - |
directUsers | [PublicUser!]! | - |
createdAt | DateTime! | - |
updatedAt | DateTime! | - |
publisher | User! | - |
sections | [WebTVSection!]! | - |
account | Account | - |
relatedTags | [Tag] | - |
relatedCategories | [Category] | - |
about | WebTVAbout | - |
template | WebTVTemplate | - |
groups | [WebTVGroup!]! | - |
links | [WebTVLink] | - |
contactPage | WebTVContactPage | - |
seo | SEO | - |
menu | [WebTVMenu!]! | - |
preRoll | RollPreset | - |
postRoll | RollPreset | - |
tracking | WebTVTracking | Outils de mesure d'audience branchés sur le site. |
confidentiality | Confidentiality | - |
privacy | Privacy | Inscription des spectateurs. |
| 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.