Structure de la requête de base

Cette page décrit la structure de requête de base pour les appels à Broadsign Control API en utilisant REST.

Pour notre exemple, nous utiliserons la méthode permettant de lister les critères qui existent sur notre domaine.

Copier 
curl -X GET "https://api-sandbox.broadsign.com:10889/rest/criteria/v8" -H "accept: application/json" -H "Authorization: Bearer YourAPIKeyHere"

 

Composant de requête Description
Verbe HTTP Dans cet exemple, nous utilisons GET pour répertorier les ressources. Nous utilisons les verbes suivants dans notre architecture REST :
  • HTTP GET : Utilisé pour lister les ressources.
  • HTTP PUT : Utilisé pour mettre à jour une ressource.
  • HTTP POST : Utilisé pour créer une ressource.

Pour une liste de toutes les ressources, consultez La référence de méthode REST .
Point de terminaison

Noms d'hôte Broadsign Control API

Broadsign fournit deux points de terminaison (noms d'hôtes) :

  • https://api-sandbox.broadsign.com : Le point de terminaison de l'environnement de test, pour tester votre intégration. Voir À propos de l'environnement de test (REST).
  • https://api.broadsign.com : Le point de terminaison en production.
10889 Le port par lequel toutes les requêtes API vers Broadsign Server sont acheminées, que ce soit sur en environnement de test ou en production.
Nom de la ressource Dans notre exemple, la ressource que nous souhaitons lister est criteria. Cette requête fera la liste de tous les critères sur notre domaine. Pour une liste de toutes les ressources, consultez la référence de méthode REST .
Numéro de version de la ressource Dans notre exemple, le numéro de version de la ressource est v8. Les numéros de version des ressources s'incrémentent indépendamment les uns des autres. Ainsi, la ressource critères est à v8 tandis que notre ressource réservation (campagne) est à v12. Assurez-vous que vous utilisez le numéro de version de ressource correct. Voir la référence de la méthode REST .
Type de contenu Notre architecture REST fournit toutes les réponses en JSON. Définir le type sur application/json.
Autorisation Broadsign accepte deux types de méthodes d'authentification : jeton HTTP ou empreinte de clé publique. Dans cet exemple, nous utilisons un jeton HTTP. Nous vous recommandons d’utiliser le jeton pour tester l’intégration sur votre domaine de test et d’utiliser l’empreinte de clé publique en production. Voir Authentification (REST).