Métodos da API de gerenciamento de domínio

Última atualização em 2023-05-20
  • Tópicos
  • API
    Exibir mais informações sobre este tópico

Métodos de gerenciamento de domínio que permitem criar e gerenciar os domínios para os quais deseja enviar dados (somente para destinos de cookies).

Criar um novo domínio

A POST que permite criar um novo domínio para (somente destinos de cookies).

Solicitação

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

Solicitação de exemplo

{
   "url":"example1.com"
}

Resposta

Uma resposta bem-sucedida retorna 201 created e o site do parceiro, incluindo sua ID exclusiva.

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

Excluir um domínio

A DELETE que permite remover um domínio (somente para destinos de cookies).

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna 204 no content. Devoluções 404 not found se o site do parceiro não puder ser encontrado.

Retornar propriedades de um domínio

A GET que retorna detalhes sobre o domínio especificado (somente para destinos de cookies).

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna 200 OK e dados como mostrado na amostra abaixo. Devoluções 404 Not found se a ID do site ou o parceiro não for encontrado.

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

Propriedades de retorno para todos os domínios

A GET que retorna informações sobre todos os domínios (somente para destinos de cookies).

Solicitação

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

Parâmetros de consulta opcionais

Você pode usar esses parâmetros opcionais com API métodos que retornam all propriedades de um objeto. Defina essas opções na string de solicitação ao transmitir essa consulta para o API. Consulte Parâmetros opcionais.

Parâmetro Descrição
page Retorna resultados por número de página. A numeração começa em 0.
pageSize Define o número de resultados de resposta retornados pela solicitação (10 é o padrão).
sortBy Classifica e retorna resultados de acordo com a propriedade JSON especificada.
descending Classifica e retorna resultados em ordem decrescente. Crescente é o padrão.
search Retorna resultados com base na cadeia de caracteres especificada que você deseja usar como parâmetro de pesquisa. Por exemplo, digamos que você queira encontrar resultados para todos os modelos que têm a palavra "Teste" em qualquer um dos campos de valor para esse item. Seu exemplo de solicitação pode ser semelhante a:

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

Você pode pesquisar qualquer valor retornado por um método "get all".

Resposta

Uma resposta bem-sucedida retorna 200 OK e dados em uma matriz, conforme mostrado na amostra abaixo. Devoluções 404 Not found se a ID do site ou o parceiro não for encontrado.

[
    {
        "pid": 1111,
        "siteId": 111,
        "url": "example1.com"
    },
    {
        "pid": 2222,
        "siteId": 222,
        "url": "example2.com"
    },
    {
        "pid": 3333,
        "siteId": 333,
        "url": "example3.com"
    }
]
Página anterior
Next page

Nesta página