Méthodes d’API de gestion de domaine

Dernière mise à jour : 2021-07-19
  • Rubriques :
  • API
    Afficher plus sur ce sujet

Méthodes de gestion des domaines qui vous permettent de créer et gérer les domaines auxquels vous souhaitez envoyer des données (pour les destinations de cookies uniquement).

Création d’un domaine

Méthode POST qui permet de créer un domaine pour (destinations de cookie uniquement).

Demande

POST https://api.demdex.com/v1/partner-sites/

Exemple de requête

{
   "url":"example1.com"
}

Réponse

Une réponse réussie renvoie 201 created et le site du partenaire, y compris son identifiant unique.

{
    "pid": 1111,
    "siteId": 111,
    "url": "example1.com"
}

Suppression d’un domaine

Méthode DELETE qui permet de supprimer un domaine (pour les destinations de cookie uniquement).

Demande

DELETE https://api.demdex.com/v1/partner-sites/<site-Id>

Réponse

Une réponse réussie renvoie 204 no content. Renvoie 404 not found si le site du partenaire est introuvable.

Renvoi des propriétés d’un domaine

Une méthode GET qui renvoie des détails sur le domaine spécifié (pour les destinations de cookie uniquement).

Demande

GET https://api.demdex.com/v1/partner-sites/<siteId>

Réponse

Une réponse réussie renvoie 200 OK et des données comme illustré dans l’exemple ci-dessous. Renvoie 404 Not found si l’ID de site ou le partenaire est introuvable.

{
    "pid": 1111,
    "siteId": 111,
    "url": "example1.com"
}

Propriétés de retour pour tous les domaines

Une méthode GET qui renvoie des informations sur tous vos domaines (pour les destinations de cookie uniquement).

Demande

GET https://api.demdex.com/v1/partner-sites/

Paramètres de requête facultatifs

Vous pouvez utiliser ces paramètres facultatifs avec des méthodes API qui renvoient les propriétés all d’un objet. Définissez ces options dans la chaîne de requête lors de la transmission de cette requête à API. Voir Paramètres facultatifs.

Paramètre Description
page Renvoie les résultats par numéro de page. La numérotation commence à 0.
pageSize Définit le nombre de résultats de réponse renvoyés par la requête (10 est la valeur par défaut).
sortBy Trie et renvoie les résultats en fonction de la propriété JSON spécifiée.
descending Trie et renvoie les résultats dans l’ordre décroissant. La valeur ascendante est la valeur par défaut.
search Renvoie des résultats en fonction de la chaîne spécifiée que vous souhaitez utiliser comme paramètre de recherche. Par exemple, supposons que vous souhaitiez trouver des résultats pour tous les modèles ayant le mot "Test" dans l’un des champs de valeur de cet élément. Votre exemple de requête peut ressembler à ceci :

`GET` `https://api.demdex.com/v1/models/?search=Test`.

Vous pouvez effectuer une recherche sur n’importe quelle valeur renvoyée par une méthode "get all".

Réponse

Une réponse réussie renvoie 200 OK et des données dans un tableau, comme illustré dans l’exemple ci-dessous. Renvoie 404 Not found si l’ID de site ou le partenaire est introuvable.

[
    {
        "pid": 1111,
        "siteId": 111,
        "url": "example1.com"
    },
    {
        "pid": 2222,
        "siteId": 222,
        "url": "example2.com"
    },
    {
        "pid": 3333,
        "siteId": 333,
        "url": "example3.com"
    }
]

Sur cette page