Developer Network

Documentação

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

Contas

Manipulando contas via API do Email Marketing.

Listagem

Lista todas as contas vinculadas ao usuário.

GET: https://DOMINIO/api/v1/accounts
Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "page" : {
    "current" : 1,
    "total" : 1
    },
  "items" : [
  {
    "id" : "4f61f4d96fbafc957d000003",
    "display_name" : "Conta 1",
    "plan_name" : "Email Marketing I"
    },
    {
      "id" : "4f1993072c1e5813a4000003",
      "display_name" : "Conta 2",
      "plan_name" : "Email Marketing II"
    }
  ]
}

Detalhes

Exibe detalhes de uma determinada conta.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA
Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "id" : "4f1993072c1e5813a4000003",
  "created_at" : "12-01-01 00:00:00",
  "return_path_domain_valid" : {
    "valid" : true
  },
  "email" : "email@locaweb.com.br",
  "return_path_domain" : "emkt.locaweb.com.br",
  "display_name" : "Conta 1",
  "plan_name" : "Email Marketing I",
  "credits" : {
    "monthly" : 10000000,
    "consumed_this_month" : 0,
    "pre_paid" : 1000,
    "monthly_renewal_with" : 0,
    "monthly_renewal_at" : "2012-02-01"
  }
}

Edição

Atualiza dados de uma conta. Atualmente só é possível editar o domínio de Return-Path.

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

Parametros:

1
2
3
4
5
{
  "account": {
    "return_path_domain": "emkt2.locaweb.com.br"
  }
}

Retorno de status HTTP: 204

Retorno: “”