Como utilizar a API – Revenda de Email Marketing

• É possível realizar o gerenciamento de sua Revenda de Email Marketing através do uso de requisições API, utilizando o padrão REST e o formato JSON codificado em UTF-8, para cadastrar novos clientes, alterar recorrência de envios, ativar ou desativá-los, dentre outros.
• Todos os cógidos e dados necessários para as requisições, estarão descritos abaixo.

Dados necessários

• Fiddler (Indicamos o uso dessas ferramentas para requisições via webservice.)
• Resale ID: Identificação da conta de revenda disponível no painel de configuração para API.
• URL da requisição: https://emailmarketing.locaweb.com.br/api/v1
• Token da API: código de autenticação fornecido no painel de configuração da revenda

Testando as requisições

Adiciona ou Remover envios ao cliente

• Requisição: PUT
• URL adicionar: /api/v1/resales/:resale_id/clients/:id_client/add_messages

• URL remover: /api/v1/resales/:resale_id/clients/:id_client/remove_messages

{
  "value": 100
}

Mudar o valor de renovação do cliente para o próximo mês

• Requisição: PUT
• URL: /api/v1/resales/:resale_id/clients/:id_client/change_recurrence

{
  "value": 100
}

Alterar dados de um cliente

• Requisição: PUT
• URL: /api/v1/resales/:resale_id/clients/:id

{
  "client": {
   "name": "Nome do Cliente",
   "email": "email@dominio.com.br",
   "info": "Informações sobre o cliente"
  }
}

Criar ou Excluir um cliente

Adicionar

• Requisição: POST
• URL: /api/v1/resales/:resale_id/clients

{
  "client": {
   "name": "Nome do Cliente",
   "email": "email@dominio.com.br",
   "password": "Senha123",
   "password_confirmation": "Senha123",
   "renew_messages": 1000, 
   "recurrent": true, 
   "info": "Informações sobre o cliente"
  }
}

Excluir

• Requisição: DELETE
• URL: /api/v1/resales/:resale_id/clients/:id

Alterar configurações

• Requisição: PUT
• URL: /api/v1/resales/:id/settings

{
  "resale": {
    "layout_color": "green",
    "helpdesk_id": "ID_HELPDESK",
    "phone": "9999-9999",
    "area_code": "11",
    "page_title": "titulo",
    "access_url": "url",
    "logo": "http://mylogo.com",
    "sender": "remetente padrão",
    "domain": "dominio padrão"
  }
}

Listar todas as transações

• Requisição: GET
• URL: /api/v1/resales/:id/trasanction_history
• Retorno esperado:

{
"items": [1]
0:  {
"id": ID_TRANSAÇÃO
"value": -1000
"type": "Envios recorrentes"
"client_id": ID_CLIENTE
"created_at": "16-01-20 15:15:45"
}

Listar todas as revendas vinculadas ao usuário

• Requisição: GET
• URL: /api/v1/resales
• Retorno esperado:

{
"items": [1]
0:  {
"id": ID_RESALE
"monthly_messages": 60000 #Saldo revenda
"name": "usuario_revenda"
}-
-
"page": {
"current": 1
"total": 1
}-
}

Exibir detalhes de uma determinada revenda

• Requisição: GET
• URL: /api/v1/resales/:id
• Retorno esperado:

{
"id": ID_RESALE
"monthly_messages": 60000 #Saldo revenda
"name": "usuario_revenda"
"created_at": "15-11-18 15:56:47"
"updated_at": "16-01-18 16:50:50"
}

Exibir detalhes de um determinado cliente

• Requisição: GET
• URL: /api/v1/resales/:resale_id/clients/:id
• Retorno esperado:

{
"id": 62771
"email": "email@dominio.com.br"
"display_name": "Nome do Cliente"
"plan_name": "E-mail Marketing"
"created_at": "16-01-18 15:43:38"
"info": "Informações sobre o cliente"
"status": "enabled"
"user_token": "c9appiUBzUqGuSfHypXMVbCXasAseATRS6S4r"
"actual_period": {
"start_on": "18/01/2016"
"end_on": "17/02/2016"
"bought": 1000
"extra_messages": "1.100"
"consumed_this_month": 0
"available": 1000
}-
"next_period": {
"start_on": "18/02/2016"
"end_on": "17/03/2016"
"renew_with": 1000
}-
}

Listar todos os clientes

• Requisição: GET
• URL: /api/v1/resales/:resale_id/clients
• Retorno esperado:

{
"items": [2]
0:  {
"id": 69971
"display_name": "Nome do Cliente"
"plan_name": "E-mail Marketing"
"messages_bought": 1000
"status": "enabled"
"user_token": "c9appiUBzUqGuSbCX8Qg85s46xsqMJMJj6S4r"
}-
1:  {
"id": 61644
"display_name": "Nome do cliente - 2"
"plan_name": "E-mail Marketing"
"messages_bought": 10000
"status": "enabled"
"user_token": "hZs414n8cdqxzBL8H2axtJRTBCEAX9QRMqgwr"
}-
"page": {
"current": 1
"total": 1
}-
}

Desativar ou Reativar um cliente

Desativar

• Requisição: PUT
• URL: /api/v1/resales/:resale_id/clients/:id/disable

Ativar

• Requisição: PUT
• URL: /api/v1/resales/:resale_id/clients/:id/enable

Cancelar a recorrência do cliente

• Requisição: PUT
• URL: /api/v1/resales/:resale_id/clients/:id/cancel_recurrence