Une ressource WebResource est une représentation d'un site Web ou d'un domaine validé.
Elle contient l'ID canonique d'un site ou d'un domaine, l'URL ou le nom du domaine, ainsi qu'une liste de propriétaires. Notez que la liste des propriétaires inclut toujours l'utilisateur authentifié, car les seuls utilisateurs ayant accès à une ressource WebResource sont les propriétaires de ce site ou de ce domaine.
La liste des méthodes associées à cette ressource est présentée au bas de la page.
Représentations de la ressource
{ "id": string, "site": { "type": string, "identifier": string }, "owners": [ string ] }
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
id |
string |
Chaîne utilisée pour identifier ce site. Cette valeur doit être utilisée dans la partie id de l'URL REST pour les opérations get, update et delete. | |
owners[] |
list |
Adresses e-mail de tous les propriétaires directs et validés de cette propriété exacte. Les propriétaires indirects (par exemple, les propriétaires confirmés du domaine parent) ne sont pas inclus dans cette liste. | |
site |
object |
Conteneur pour l'adresse et le type d'un site qui est validé ou va être validé. | |
site.identifier |
string |
L'identifiant du site, qui prend différentes formes en fonction de la valeur de la propriété type . |
|
site.type |
string |
Type de site.
Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
|
Méthodes
La méthode insert vous permet de valider la propriété d'un site Web ou d'un domaine par l'utilisateur authentifié. Utilisez les méthodes get, update, et delete afin de récupérer ou de modifier une ressource qui a déjà été validée pour l'utilisateur authentifié.
Vous pouvez afficher toutes les ressources validées pour l'utilisateur authentifié à l'aide de la commande list, et vous pouvez obtenir un jeton à placer sur le site de l'utilisateur authentifié à l'aide de getToken.
- supprimer
- Ce paramètre ne vérifie pas la propriété d'un site Web ou d'un domaine de l'utilisateur.
- get
- Récupère les données les plus récentes d'un site Web ou d'un domaine.
- getToken
- Récupère un jeton de validation à placer par l'utilisateur authentifié sur un site Web ou un domaine.
- insérer
- Vérifie la propriété d'un site Web ou d'un domaine.
- liste
- Récupère la liste des sites Web et domaines validés de l'utilisateur authentifié.
- mise à jour
- Modifie la liste des propriétaires d'un site Web ou d'un domaine.