{"id":3661,"date":"2018-07-11T09:54:06","date_gmt":"2018-07-11T12:54:06","guid":{"rendered":"https:\/\/wiki3.locaweb.com.br\/?post_type=ht_kb&#038;p=3661"},"modified":"2022-10-07T12:05:38","modified_gmt":"2022-10-07T15:05:38","slug":"como-utilizar-a-api-revenda-de-email-marketing","status":"publish","type":"ht_kb","link":"https:\/\/www.locaweb.com.br\/ajuda\/wiki\/como-utilizar-a-api-revenda-de-email-marketing\/","title":{"rendered":"Como utilizar a API &#8211; Revenda de Email Marketing"},"content":{"rendered":"    \t\t<div class=\"hts-messages hts-messages--info  hts-messages--withtitle hts-messages--withicon \"   >\r\n    \t\t\t<span class=\"hts-messages__title\"><b>Informa\u00e7\u00e3o!<\/b><\/span>    \t\t\t    \t\t\t\t<p>\r\n    \t\t\t\t\tNeste artigo veremos como utilizar APIs para conectar seu servi\u00e7o de Revenda de Email Marketing com seu sistema.    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div><!-- \/.ht-shortcodes-messages -->\r\n    \t\t\n<ul>\n<li style=\"text-align: justify;\">\u00c9 poss\u00edvel realizar o gerenciamento de sua Revenda de Email Marketing atrav\u00e9s do uso de requisi\u00e7\u00f5es API, utilizando o padr\u00e3o REST e o formato JSON codificado em UTF-8, para cadastrar novos clientes, alterar recorr\u00eancia de envios, ativar ou desativ\u00e1-los, dentre outros.<\/li>\n<li style=\"text-align: justify;\">Todos os c\u00f3gidos e dados necess\u00e1rios para as requisi\u00e7\u00f5es, estar\u00e3o descritos abaixo.<\/li>\n<\/ul>\n<p><strong>Dados necess\u00e1rios<\/strong><\/p>\n<ul>\n<li><b><a href=\"http:\/\/www.telerik.com\/fiddler\" target=\"_blank\" rel=\"noopener noreferrer\">Fiddler<\/a> <small>(Indicamos o uso dessas ferramentas para requisi\u00e7\u00f5es via webservice.)<\/small><\/b><\/li>\n<li><b>Resale ID:\u00a0<\/b>Identifica\u00e7\u00e3o da conta de revenda dispon\u00edvel no painel de configura\u00e7\u00e3o para API.<\/li>\n<li><b>URL da requisi\u00e7\u00e3o:\u00a0<\/b>https:\/\/emailmarketing.locaweb.com.br\/api\/v1<\/li>\n<li><b>Token da API:\u00a0<\/b>c\u00f3digo de autentica\u00e7\u00e3o fornecido no painel de configura\u00e7\u00e3o da revenda<\/li>\n<\/ul>\n<p><strong>Testando as requisi\u00e7\u00f5es<\/strong><\/p>\n<p>Adiciona ou Remover envios ao cliente<\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL adicionar:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id_client\/add_messages<\/b><\/li>\n<\/ul>\n<ul>\n<li>URL remover:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id_client\/remove_messages<\/b><\/li>\n<\/ul>\n<pre>{\r\n  \"value\": 100\r\n}<\/pre>\n<p><strong>Mudar o valor de renova\u00e7\u00e3o do cliente para o pr\u00f3ximo m\u00eas<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id_client\/change_recurrence<\/b><\/li>\n<\/ul>\n<pre>{\r\n  \"value\": 100\r\n}<\/pre>\n<p><strong>Alterar dados de um cliente<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id<\/b><\/li>\n<\/ul>\n<pre>{\r\n  \"client\": {\r\n   \"name\": \"Nome do Cliente\",\r\n   \"email\": \"email@dominio.com.br\",\r\n   \"info\": \"Informa\u00e7\u00f5es sobre o cliente\"\r\n  }\r\n}<\/pre>\n    \t\t<div class=\"hts-messages hts-messages--alert  hts-messages--withtitle hts-messages--withicon \"   >\r\n    \t\t\t<span class=\"hts-messages__title\"><b>Importante!<\/b><\/span>    \t\t\t    \t\t\t\t<p>\r\n    \t\t\t\t\tS\u00f3 \u00e9 necess\u00e1rio enviar o campo a ser alterado.    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div><!-- \/.ht-shortcodes-messages -->\r\n    \t\t\n<p><strong>Criar ou Excluir um cliente<\/strong><\/p>\n<p><strong>Adicionar<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>POST<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients<\/b><\/li>\n<\/ul>\n<pre>{\r\n  \"client\": {\r\n   \"name\": \"Nome do Cliente\",\r\n   \"email\": \"email@dominio.com.br\",\r\n   \"password\": \"Senha123\",\r\n   \"password_confirmation\": \"Senha123\",\r\n   \"renew_messages\": 1000, \r\n   \"recurrent\": true, \r\n   \"info\": \"Informa\u00e7\u00f5es sobre o cliente\"\r\n  }\r\n}<\/pre>\n<p><strong>Excluir<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>DELETE<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id<\/b><\/li>\n<\/ul>\n<p><strong>Alterar configura\u00e7\u00f5es<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:id\/settings<\/b><\/li>\n<\/ul>\n<pre>{\r\n  \"resale\": {\r\n    \"layout_color\": \"green\",\r\n    \"helpdesk_id\": \"ID_HELPDESK\",\r\n    \"phone\": \"9999-9999\",\r\n    \"area_code\": \"11\",\r\n    \"page_title\": \"titulo\",\r\n    \"access_url\": \"url\",\r\n    \"logo\": \"http:\/\/mylogo.com\",\r\n    \"sender\": \"remetente padr\u00e3o\",\r\n    \"domain\": \"dominio padr\u00e3o\"\r\n  }\r\n}<\/pre>\n    \t\t<div class=\"hts-messages hts-messages--alert  hts-messages--withtitle hts-messages--withicon \"   >\r\n    \t\t\t<span class=\"hts-messages__title\"><b>Importante!<\/b><\/span>    \t\t\t    \t\t\t\t<p>\r\n    \t\t\t\t\tSo \u00e9 necess\u00e1rio enviar o campo a ser alterado. Valores de layout color: aqua, blue, green, navy_blue, orange, purple, wine, yellow.    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div><!-- \/.ht-shortcodes-messages -->\r\n    \t\t\n<p><strong>Listar todas as transa\u00e7\u00f5es<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>GET<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:id\/trasanction_history<\/b><\/li>\n<li>Retorno esperado:<\/li>\n<\/ul>\n<pre>{\r\n\"items\": [1]\r\n0:  {\r\n\"id\": ID_TRANSA\u00c7\u00c3O\r\n\"value\": -1000\r\n\"type\": \"Envios recorrentes\"\r\n\"client_id\": ID_CLIENTE\r\n\"created_at\": \"16-01-20 15:15:45\"\r\n}<\/pre>\n<p><strong>Listar todas as revendas vinculadas ao usu\u00e1rio<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>GET<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales<\/b><\/li>\n<li>Retorno esperado:<\/li>\n<\/ul>\n<pre>{\r\n\"items\": [1]\r\n0:  {\r\n\"id\": ID_RESALE\r\n\"monthly_messages\": 60000 #Saldo revenda\r\n\"name\": \"usuario_revenda\"\r\n}-\r\n-\r\n\"page\": {\r\n\"current\": 1\r\n\"total\": 1\r\n}-\r\n}<\/pre>\n<p><strong>Exibir detalhes de uma determinada revenda<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>GET<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:id<\/b><\/li>\n<li>Retorno esperado:<\/li>\n<\/ul>\n<pre>{\r\n\"id\": ID_RESALE\r\n\"monthly_messages\": 60000 #Saldo revenda\r\n\"name\": \"usuario_revenda\"\r\n\"created_at\": \"15-11-18 15:56:47\"\r\n\"updated_at\": \"16-01-18 16:50:50\"\r\n}\r\n<\/pre>\n<p><strong>Exibir detalhes de um determinado cliente<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>GET<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id<\/b><\/li>\n<li>Retorno esperado:<\/li>\n<\/ul>\n<pre>{\r\n\"id\": 62771\r\n\"email\": \"email@dominio.com.br\"\r\n\"display_name\": \"Nome do Cliente\"\r\n\"plan_name\": \"E-mail Marketing\"\r\n\"created_at\": \"16-01-18 15:43:38\"\r\n\"info\": \"Informa\u00e7\u00f5es sobre o cliente\"\r\n\"status\": \"enabled\"\r\n\"user_token\": \"c9appiUBzUqGuSfHypXMVbCXasAseATRS6S4r\"\r\n\"actual_period\": {\r\n\"start_on\": \"18\/01\/2016\"\r\n\"end_on\": \"17\/02\/2016\"\r\n\"bought\": 1000\r\n\"extra_messages\": \"1.100\"\r\n\"consumed_this_month\": 0\r\n\"available\": 1000\r\n}-\r\n\"next_period\": {\r\n\"start_on\": \"18\/02\/2016\"\r\n\"end_on\": \"17\/03\/2016\"\r\n\"renew_with\": 1000\r\n}-\r\n}<\/pre>\n<p><strong>Listar todos os clientes<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>GET<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients<\/b><\/li>\n<li>Retorno esperado:<\/li>\n<\/ul>\n<pre>{\r\n\"items\": [2]\r\n0:  {\r\n\"id\": 69971\r\n\"display_name\": \"Nome do Cliente\"\r\n\"plan_name\": \"E-mail Marketing\"\r\n\"messages_bought\": 1000\r\n\"status\": \"enabled\"\r\n\"user_token\": \"c9appiUBzUqGuSbCX8Qg85s46xsqMJMJj6S4r\"\r\n}-\r\n1:  {\r\n\"id\": 61644\r\n\"display_name\": \"Nome do cliente - 2\"\r\n\"plan_name\": \"E-mail Marketing\"\r\n\"messages_bought\": 10000\r\n\"status\": \"enabled\"\r\n\"user_token\": \"hZs414n8cdqxzBL8H2axtJRTBCEAX9QRMqgwr\"\r\n}-\r\n\"page\": {\r\n\"current\": 1\r\n\"total\": 1\r\n}-\r\n}<\/pre>\n<p><strong>Desativar ou Reativar um cliente<\/strong><\/p>\n<p><strong>Desativar<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id\/disable<\/b><\/li>\n<\/ul>\n<p><strong>Ativar<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id\/enable<\/b><\/li>\n<\/ul>\n<p><strong>Cancelar a recorr\u00eancia do cliente<\/strong><\/p>\n<ul>\n<li>Requisi\u00e7\u00e3o:\u00a0<b>PUT<\/b><\/li>\n<li>URL:\u00a0<b>\/api\/v1\/resales\/:resale_id\/clients\/:id\/cancel_recurrence<\/b><\/li>\n<\/ul>\n    \t\t<div class=\"hts-messages hts-messages--success  hts-messages--withtitle hts-messages--withicon \"   >\r\n    \t\t\t<span class=\"hts-messages__title\"><b>Pronto!<\/b><\/span>    \t\t\t    \t\t\t\t<p>\r\n    \t\t\t\t\tAgora voc\u00ea j\u00e1 sabe como realizar a conex\u00e3o via API.    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div><!-- \/.ht-shortcodes-messages -->\r\n    \t\t\n    \t\t<div class=\"hts-messages hts-messages--info  hts-messages--withtitle hts-messages--withicon \"   >\r\n    \t\t\t<span class=\"hts-messages__title\"><b>Conhe\u00e7a!<\/b><\/span>    \t\t\t    \t\t\t\t<p>\r\n    \t\t\t\t\tAproveite e conhe\u00e7a outros produtos da Locaweb, como o Revenda Plesk, <a href=\"https:\/\/www.locaweb.com.br\/revenda-de-hospedagem\/revenda-plesk\/\" target=\"_blank\" rel=\"noopener noreferrer\">clique aqui<\/a> e saiba mais!    \t\t\t\t<\/p>\r\n    \t\t\t    \t\t\t\r\n    \t\t<\/div><!-- \/.ht-shortcodes-messages -->\r\n    \t\t\n","protected":false},"excerpt":{"rendered":"<p>\u00c9 poss\u00edvel realizar o gerenciamento de sua Revenda de Email Marketing atrav\u00e9s do uso de requisi\u00e7\u00f5es API, utilizando o padr\u00e3o REST e o formato JSON codificado em UTF-8, para cadastrar novos clientes, alterar recorr\u00eancia de envios, ativar ou desativ\u00e1-los, dentre outros. Todos os c\u00f3gidos e dados necess\u00e1rios para as requisi\u00e7\u00f5es,&#8230;<\/p>\n","protected":false},"author":6,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[113],"ht-kb-tag":[376],"class_list":["post-3661","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-revenda-de-email-marketing","ht_kb_tag-categoriaemail-marketing"],"_links":{"self":[{"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb\/3661","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/comments?post=3661"}],"version-history":[{"count":12,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb\/3661\/revisions"}],"predecessor-version":[{"id":27642,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb\/3661\/revisions\/27642"}],"wp:attachment":[{"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/media?parent=3661"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb-category?post=3661"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.locaweb.com.br\/ajuda\/wp-json\/wp\/v2\/ht-kb-tag?post=3661"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}