Skip to content

Lista de domínios

Painel Multiusuário disponível a partir do plano CUSTOM

Gerenciamento de listas de domínios para permissões de acesso.

Lista de domínios - Alterar lista de domínios

Altera uma lista de domínios

Substitui os domínios em uma lista de domínios existente pelos domínios enviados no parâmetro domain[].

PUT /v1/domain-list/{id}
$ curl -i "https://api.gocache.com.br/v1/domain-list/99" \
-X PUT \
-H 'GoCache-Token:seu_token' \
-d 'name=Minha Lista' \
-d 'domain[]=seudominio.com.br' \
-d 'domain[]=outrodominio.com.br' \
<?php


$ch = curl_init("https://api.gocache.com.br/v1/domain-list/99");

curl_setopt($ch, CURLOPT_PUT, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

curl_setopt($ch, CURLOPT_HTTPHEADER, array("GoCache-Token: seu_token"));
$urls = array(
        "name=Minha Lista",
        "domain[]=seudominio.com.br",
        "domain[]=outrodominio.com.br"
        );
curl_setopt($ch, CURLOPT_POSTFIELDS, implode("&", $urls));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);
?>

Parâmetros

Campo Opcional Tipo Descrição
id Number Identificador da lista de domínios. Esse identificador pode ser obtido usando GET ou ao cadastrar a lista.
domain String[] domínios que irão substituir o conteúdo prévio da lista.
name String Nome da lista de domínios
type String
Tipo da lista de domínios.

Sendo representado por wildcard, append e default (padrão).

Uma lista do tipo wildcard representa todos os domínios. Fazendo com que a lista seja composta por todos os domínios cadastrados na conta, incluindo os domínios futuramente inseridos. Essa opção descarta a necessidade do parâmetro domain[]

A lista do tipo append, garante que a lista atual será preenchida com quaisquer domínios que forem inseridos no futuro.

Essa opção torna optativo a necessidade do parâmetro domain[], porém ainda é possivel passar alguns domínios pré existentes para compor essa lista.

A lista do tipo default representa uma lista estática somente com os domínios inseridos pelo parâmetro domain[]. Novos domínios não serão inclusos.

Valores permitidos: "wildcard", "append", "default"

Exemplo de sucesso:

HTTP/1.1 200 OK
{
  "status_code": 200,
  "response": [
    {
      "created_at": "2021-01-13 19:00:58",
      "id": 99,
      "domains": [
        "seudominio.com.br",
        "outrodominio.com.br"
      ],
      "name": "principais",
      "type": "default"
    }
  ]
}
<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Lista atualizada: " . $obj->result[0] );
}     
?>

Lista de domínios - Criar lista de domínios

Cria uma lista de domínios para limitar os domínios ao qual o usuário terá permissão de acesso. A lista deverá ser associada a um usuário para que as permissões associadas aos domínios sejam aplicadas.

POST /v1/domain-list
$ curl -i "https://api.gocache.com.br/v1/domain-list" \
-X POST \
-H 'GoCache-Token:seu_token' \
-d "name=Meus dominios" \
-d 'domain[]=seudominio.com.br' \
-d 'domain[]=outrodominio.com.br' \
-d 'domain[]=maisumdominio.com.br'
-d 'type=append'
<?php

$ch = curl_init("https://api.gocache.com.br/v1/domain-list");

curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

curl_setopt($ch, CURLOPT_HTTPHEADER, array("GoCache-Token: seu_token"));
$urls = array(
        "name=Meus dominios",
        "domain[]=seudominio.com.br",
        "domain[]=outrodominio.com.br",
        "domain[]=maisumdominio.com.br",
        );
curl_setopt($ch, CURLOPT_POSTFIELDS, implode("&", $urls));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);
?>

Parâmetros

Campo Opcional Tipo Descrição
name String Nome da lista de domínios
domain String[] Vetor com os domínios que serão inseridos na lista
type String
Tipo da lista de domínios.

Sendo representado por wildcard, append e default (padrão).

Uma lista do tipo wildcard representa todos os domínios. Fazendo com que a lista seja composta por todos os domínios cadastrados na conta, incluindo os domínios futuramente inseridos. Essa opção descarta a necessidade do parâmetro domain[]

A lista do tipo append, garante que a lista atual será preenchida com quaisquer domínios que forem inseridos no futuro.

Essa opção torna optativo a necessidade do parâmetro domain[], porém ainda é possivel passar alguns domínios pré existentes para compor essa lista.

A lista do tipo default representa uma lista estática somente com os domínios inseridos pelo parâmetro domain[]. Novos domínios não serão inclusos.

Valores permitidos: "wildcard", "append", "default"

Exemplo de sucesso

HTTP/1.1 200 OK
{
   "status_code": 200,
   "response": {
    "id": 425
   }
}
<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("ID da lista de dominios: " . $obj['result']['id'] );

}
?>

Lista de domínios - Exibir listas de dominios

Consulta listas de domínios cadastradas

GET /v1/domain-list
$ curl -i "https://api.gocache.com.br/v1/domain-list" \
-H 'GoCache-Token:seu_token'
<?php

$ch = curl_init("https://api.gocache.com.br/v1/domain-list");

curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

curl_setopt($ch, CURLOPT_HTTPHEADER, array("GoCache-Token: seu_token"));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);
?>

Exemplo de sucesso:

HTTP/1.1 200 OK
{
  "status_code": 200,
  "result": [
    {
      "id": 1,
      "type": "default",
      "name" : "Meus dominios",
      "domains": [
        "seudominio.com"
      ],
      "created_at": "2020-11-05 17:40:51"
    },
    {
      "id": 2,
      "type": "append",
      "name" : "Outros dominios",
      "domains": [
        "seudominio.com.br",
        "outrodominio.com.br",
        "melhordominio.com.br",
        "utimodominio.com.br"
      ],
      "created_at": "2020-11-05 17:41:09"
    }
  ]
}
<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    print_r($obj);

}
?>

Lista de domínios - Remover lista de domínios

Remove lista de domínios

DELETE  /v1/domain-list/{id}
$ curl -i "https://api.gocache.com.br/v1/domain-list/10" \
-X DELETE \
-H 'GoCache-Token:seu_token'
<?php


$ch = curl_init("https://api.gocache.com.br/v1/domain-list/10");

curl_setopt($ch, CURLOPT_DELETE, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

curl_setopt($ch, CURLOPT_HTTPHEADER, array("GoCache-Token: seu_token"));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);
?>

Parâmetros

Campo Opcional Tipo Descrição
id Number Identificador da lista de domínios. Esse identificador pode ser obtido usando GET ou ao cadastrar a lista.

Exemplo de sucesso:

HTTP/1.1 200 OK
{
  "status_code": 200
}
<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Resultado: " . $obj->status);
}
?>