Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Domínios

Como manipular e criar domínios do Email Marketing Locaweb.

Listagem

Listagem das domínios de uma determinada conta.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/domains

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "page" : {
    "current" : 1,
    "total" : 1
  },
  "items" : [
    {
      "dns_valid" : {
        "cname" : {
          "valid" : true
        }
      },
      "id" : "4f4696b44cfc378a3c000002",
      "name" : "DOMINIO",
      "default" : false
    },
    {
      "dns_valid" : {
        "cname" : {
          "valid" : true
        }
      },
      "id" : "4f3d238d4cfc371414000002",
      "name" : "DOMINIO",
      "default" : true
    }
  ]
}

Detalhes

Detalhes de um determinado domínio.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/domains/ID_DOMINIO

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "dns_valid" : {
    "cname" : {
      "valid" : true
    }
  },
  "id" : "4f3d238d4cfc371414000002",
  "created_at" : "12-02-16 13:41:01",
  "updated_at" : "12-06-08 10:25:51",
  "name" : "emkt1.locaweb.com.br",
  "default" : true
}

Criação

Criação de domínios

POST: https://DOMINIO/api/v1/accounts/ID_CONTA/domains

Parametros:

1
2
3
4
5
{
  "domain": {
    "name": "DOMINIO"
  }
}

Retorno de status HTTP: 200

Retorno:

1
2
3
{
  "id" : "4fe3684e2c1e5806df000001"
}

Edição

Atualizar determinado domínio.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/domains/ID_DOMINIO

Parametros:

1
2
3
4
5
6
{
  "domain": {
    "name": "DOMINIO",
    "default": false
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinado domínio.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/domains/ID_DOMINIO

Retorno de status HTTP: 204

Retorno: “”