Gestion des comptes
Les administrateurs de compte peuvent utiliser l'API REST d'OpenTok pour créer et gérer des projets individuels au sein de leur compte OpenTok.
Par exemple, vous souhaiterez peut-être créer différents projets correspondant à différents clients. La mise en place de projets distincts permet à OpenTok de suivre l'utilisation de manière individuelle pour chaque client.
Chaque projet dispose de son propre OpenTok unique projet Clé API et projet API clé secrète.
Par exemple, un client — Acme — utilise votre service. Vous pouvez utiliser l'API REST d'OpenTok pour créer une clé API de projet OpenTok et un secret API de projet pour ce client.
L'API REST OpenTok vous permet d'effectuer les opérations suivantes :
- Créez un nouveau projet pour votre compte OpenTok »
- Suspendre une clé API de projet ou la réactiver à nouveau
- Supprimer un projet
- Obtenir des informations sur un projet spécifique ou sur l'ensemble des projets pour créer un compte
- Générer un nouveau secret API pour un projet
- Spécifiez une destination de téléchargement sur Amazon S3 ou Microsoft Azure pour les fichiers d'archive d'un projet
- Suppression d'une destination de téléchargement pour les fichiers d'archive d'un projet
Pour les appels d'API REST suivants, utilisez le au niveau de l'account Clé API et secret. Pour obtenir la clé API et le secret au niveau de l’account, connectez-vous à votre Video API Account, cliquez Paramètres du compte dans le menu de gauche, puis sous API REST d'OpenTok, cliquez Afficher les clés du compte. La clé API et le secret au niveau de l'Account ne sont accessibles qu'aux administrateurs enregistrés de votre compte OpenTok. Utilisez la clé API et le secret au niveau de l'Account lors de la création du jeton d'authentification que vous utilisez dans l'appel à l'API REST :
- Créer un nouveau projet pour votre compte OpenTok
- Suspendre une clé API de projet ou la réactiver à nouveau
- Supprimer un projet
- Obtenir des informations sur un projet spécifique ou sur l'ensemble des projets pour créer un compte
- Générer un nouveau secret API pour un projet
La clé API et le secret au niveau de l'account ne sont accessibles qu'aux administrateurs enregistrés de votre compte OpenTok.
Pour les autres appels à l'API REST, utilisez la clé API et le secret associés au projet concerné de votre Account. Ceux-ci sont indiqués sur la page « Projet » de votre Video API Account.
Objet « Détails du projet »
De nombreuses réponses aux appels de l'API REST contiennent un objet décrivant les détails du projet. Cette partie de la réponse JSON fournit des informations sur le projet. Elle se présente sous le format suivant :
{
"id": "12312",
"secret": "567890",
"status": "ACTIVE",
"name": "Joe Montana",
"environment": "standard",
"createdAt": 1414642898000 // A UNIX timestamp (in milliseconds)
}
L'objet « Détails du projet » possède les propriétés suivantes :
-
id— La clé API du projet OpenTok -
secret— La clé secrète de l'API du projet OpenTok -
status— Si le projet est actif ("ACTIVE") ou suspendu ("SUSPENDED"). Voir aussi Suspendre ou réactiver une clé API de projet. -
name— Le nom, si vous en avez indiqué un lors de la création du projet ; ou une chaîne vide si vous n'avez pas indiqué de nom -
environment- Cette valeur est fixée à"standard"ou"enterprise", et cela fait référence à l' environnement dans lequel un projet s'exécute. Les partenaires disposant d'une offre « Enterprise » ont accès à l'environnement « Enterprise ». Pour plus d'informations, consultez notre offres d'assistance page. Si vous avez d'autres questions, n'hésitez pas à nous contacter. -
createdAt— Date et heure de création du projet (horodatage UNIX, en millisecondes)
Veuillez ne pas tenir compte des autres propriétés présentes dans l'objet « détails du projet ».