minutes de lecture
API Static Operations
Static Operations
Le module Static Operations propose un ensemble d'interfaces de programmation d'application (API) qui permettent aux développeurs de logiciels d'une entreprise d'affichage extérieur d'intégrer des applications existantes au module Static Operations de la Plateforme Broadsign.
Accédez à l'API Static Operations.
Static Operations
Vous pouvez accéder à l'API Static Operations en cliquant sur ce lien.
Si vous utilisez l'API Static Operations pour la première fois, vous devez vous inscrire.
Pour vous inscrire à l'API Static Operations :
Static Operations
- Accédez à l'API Static Operations.
- Cliquez sur le lien Sign up dans le coin supérieur droit.
- Saisissez les informations obligatoires.
- Cliquez sur Sign up.
- Suivez les instructions du courriel pour vérifier votre compte.
La fenêtre Sign up s'affiche.
Un courriel de vérification est envoyé à votre adresse courriel. Il contient un lien de vérification.
Une fois cette étape terminée, vous êtes redirigé vers la page d'inscription de l'API Static Operations.
Si vous êtes déjà membre, vous pouvez vous connecter à l'API Static Operations.
Pour vous connecter à l'API Static Operations :
Static Operations
- Accédez à l'API Static Operations.
- Cliquez sur le lien Sign in dans le coin supérieur droit.
- Saisissez vos identifiants.
- Cliquez sur Sign in.
La fenêtre Sign in s'affiche.
La page principale du portail de l'API Static Operations s'affiche. Comme vous pouvez le voir, vous avez accès à différentes options dans le menu.
La prochaine étape consiste à s'abonner à un produit.
Vous devez vous abonner à un produit pour accéder à ses API. Broadsign doit approuver votre abonnement. Vous recevrez un e-mail de confirmation une fois votre abonnement approuvé.
Pour s'abonner à un produit :
Static Operations
- Se connecter à l'API Static Operations
- Cliquez sur le lien de menu Products.
- Cliquez sur le nom du produit Broadsign Static Operations.
- Créez un abonnement au produit Broadsign Static Operations en saisissant un nom pour votre abonnement dans le champ sous Your subscriptions, puis cliquez sur Subscribe.
La page Products s'affiche. Elle liste tous les produits auxquels vous êtes abonné.
La page du produit Broadsign Static Operations s'affiche. Elle liste tous vos abonnements, le cas échéant.
La page liste également les API disponibles pour le produit Broadsign Static Operations.
| API | Description |
|---|---|
| Additional Revenues Management | API pour gérer les revenus additionnels dans Broadsign Static Operations. |
| Authentication API | API pour authentifier les utilisateurs dans Broadsign Static Operations. |
| Inventory Management | API pour gérer l'inventaire statique dans Broadsign Static Operations. |
| Operations Management | API pour gérer les opérations statiques dans Broadsign Static Operations. |
Broadsign doit approuver votre abonnement. Vous recevrez un courriel de confirmation une fois votre abonnement approuvé.
Une fois votre abonnement approuvé, la page de votre profil utilisateur affichera les informations relatives à l'abonnement.
Vous devez maintenant générer un jeton d'authentification.
Vous pouvez récupérer votre clé d'abonnement sur la page Profile en cliquant sur l'option Show keys dans le menu à points de suspension (ellipsis).
Vous aurez besoin de cette clé pour récupérer un jeton JWT pour l'authentification et pour toutes vos requêtes.
Un jeton Web JSON (JWT) valide est requis pour utiliser les points de terminaison de l'API Static Operations.
Pour récupérer un JWT pour l'authentification :
Static Operations
- Se connecter à l'API Static Operations
- Cliquez sur le lien de menu APIs.
- Cliquez sur le nom du produit Broadsign Static Operations.
- Cliquez sur le lien Authentication API.
- Cliquez sur le bouton Try this operation.
- Faites défiler vers le bas jusqu'à la section Headers, et saisissez votre Subscription key dans le champ Ocp-Apim-Subscription-Key.
- Faites défiler vers le bas jusqu'à la section Body, et saisissez vos identifiants dans le champ de texte.
- Cliquez sur Send.
La page Products s'affiche. Elle liste tous les produits auxquels vous êtes abonné.
La page du produit Broadsign Static Operations s'affiche. Elle liste tous vos abonnements, le cas échéant.
La page liste également les API disponibles sous le produit Broadsign Static.
La page Authentication API s'affiche. Elle comporte un point de terminaison, le point de terminaison GenerateAccessToken.
Les informations d'autorisation s'affichent.
L'exemple suivant montre la requête HTTPS :
curl --location 'https://ams-apigateway-cloud-ca-01.azure-api.net/authentication/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Ocp-Apim-Subscription-Key: YourApiSubscriptionKey' \
--data-urlencode 'username=your@email.com' \
--data-urlencode 'password=YourPassword'La réponse fournit le JWT dans le corps de réponse JSON, dans le champ « access_token » : « YourJWT » :
{
"access_token": "YourJWT",
"scope": "read:users",
"expires_in": 300,
"token_type": "Bearer"
}Lors de l'envoi de requêtes à l'API Static Operations, vous devez fournir le JWT récupéré dans Récupérer un jeton Web JSON (JWT) pour l'authentification comme en-tête d'authentification (Authentication Header).
L'exemple suivant montre une requête HTTPS pour l'API Static Asset Management. L'exemple utilise la requête GET GetCountries.
curl --location 'https://ams-apigateway-cloud-ca-01.azure-api.net/inventory/countries' \
--header 'Authorization: Bearer YourJWT' \
--header 'Ocp-Apim-Subscription-Key: YourApiSubscriptionKey'- Ajoutez le mot « Bearer » (suivi d'un espace) devant le JWT dans l'en-tête d'autorisation.
- Remplacez le jeton « YourJWT » dans l'en-tête Authorization par le JWT récupéré dans Récupérer un jeton Web JSON (JWT) pour l'authentification.
- Remplacez la valeur « YourApiSubscriptionKey » de l'en-tête
Ocp-Apim-Subscription-Keypar votre clé d'abonnement à l'API, comme décrit dans Récupérer votre clé d'abonnement à l'API.
Expiration du JWT
La validité du JWT est de 24 heures.
