{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/notifications/:identifier/transactional/send/","auth":"required","params":[{"name":"identifier","type":"string","default":"","desc":"Identificador da notificação que será utilizada","required":true,"in":"path","ref":"","_id":"55b7896831bccb190081bfa2"},{"name":"signature","type":"string","default":"","desc":"Assinatura (RSA com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b7896831bccb190081bfa1"},{"name":"sha1_signature","type":"string","default":"","desc":"Assinatura (SHA1 com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b7896831bccb190081bfa0"},{"name":"platform_api_key","type":"string","default":"","desc":"API KEY","required":true,"in":"body","ref":"","_id":"55b7896831bccb190081bf9f"},{"name":"encoding","type":"string","default":"","desc":"Codificação utilizada. Ex.: base64","required":false,"in":"body","ref":"","_id":"55b7896831bccb190081bf9e"},{"name":"users","type":"array_object","default":"","desc":"Conjunto dos destinatários da notificação. Dentro de cada usuário, no nó 'vars' são enviadas as variáveis a serem utilizadas no e-mail.","required":false,"in":"body","ref":"","_id":"55b78acf568be2230092ba7f"}],"results":{"codes":[{"code":"{  \n  \"data\" => {  \n    \"data\" => {  \n      \"success\" =>\"As notificações foram enfileiradas para envio.\"\n    }\n  }\n}","language":"ruby","status":200,"name":""}]},"settings":"55b29c106862a10d00887a8c","examples":{"codes":[{"name":"","code":"# Exemplo envio E-mail em Ruby\n\nrequire 'digest/sha1'\nrequire 'httparty'\n\napi_key = 'SUA_API_KEY'\nsecret = 'SUA_SECRET'\n\nidentifier = 'IDENTIFICADOR_DA_NOTIFICACAO'\n\nsignature = Digest::SHA1.hexdigest(secret)\n\nparams = {\n  platform_api_key: api_key, \n  sha1_signature: signature,\n  users: [\n  \t{\n\t\t\tname: 'User 1', \n      email: 'user.1:::at:::email.com',\n      vars: { age: '20' }\n    },\n    {\n      name: 'User 2', \n      email: '[email protected]',\n      vars: { age: '21' }\n    }\n  ]\n}\n\nHTTParty.post(\"https://notification.plataformasocial.com.br/notifications/#{identifier}/transactional/send\", body: params)\n\n# Exemplo envio SMS em Ruby\n\nrequire 'digest/sha1'\nrequire 'httparty'\n\napi_key = 'SUA_API_KEY'\nsecret = 'SUA_SECRET'\n\nidentifier = 'IDENTIFICADOR_DA_NOTIFICACAO'\n\nsignature = Digest::SHA1.hexdigest(secret)\n\nparams = {\n  platform_api_key: api_key, \n  sha1_signature: signature,\n  users: [\n  \t{\n\t\t\tname: 'User 1', \n      email: '[email protected]',\n      destination: '5531992739871', # sem o + no DDI\n      vars: { age: '20' }\n    },\n    {\n      name: 'User 2', \n      email: '[email protected]',\n      destination: '31992739871',\n      vars: { age: '21' }\n    }\n  ]\n}\n\nHTTParty.post(\"https://notification.plataformasocial.com.br/notifications/#{identifier}/transactional/send\", body: params)","language":"ruby"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Enviar notificação","type":"endpoint","slug":"enviar-uma-notificação-transacional","excerpt":"","body":"Enviar uma notificação transacional\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parâmetros da URL\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parâmetro\",\n    \"h-1\": \"Obrigatório\",\n    \"h-2\": \"Tipo\",\n    \"h-3\": \"Descrição\",\n    \"0-3\": \"Identificador da notificação que será utilizado\",\n    \"0-0\": \"identifier\",\n    \"0-2\": \"String\",\n    \"0-1\": \"Sim\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parâmetros da requisição\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parâmetro\",\n    \"h-1\": \"Obrigatório\",\n    \"h-2\": \"Tipo\",\n    \"h-3\": \"Descrição\",\n    \"0-0\": \"signature\",\n    \"1-0\": \"sha1_signature\",\n    \"2-0\": \"platform_api_key\",\n    \"3-0\": \"encoding\",\n    \"0-1\": \"Sim (Exceto se utilizar o sha1_signature)\",\n    \"1-1\": \"Sim (Exceto se utilizar o signature)\",\n    \"2-1\": \"Sim\",\n    \"3-1\": \"Não\",\n    \"3-2\": \"String\",\n    \"2-2\": \"String\",\n    \"1-2\": \"String\",\n    \"0-2\": \"String\",\n    \"0-3\": \"Assinatura gerada via RSA com a chave SECRET_KEY.\",\n    \"1-3\": \"Assinatura gerada via SHA1 com a chave SECRET_KEY.\",\n    \"2-3\": \"API_KEY do aplicativo.\",\n    \"3-3\": \"Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).\",\n    \"4-0\": \"users\",\n    \"5-0\": \"vars\",\n    \"4-1\": \"Sim\",\n    \"5-1\": \"Não\",\n    \"4-2\": \"Array of Objects\",\n    \"5-2\": \"JSON\",\n    \"4-3\": \"Conjunto de nomes e e-mails dos destinatários da notificação.\\nOpcionalmente, poderá ser enviado no objeto do usuário o nó \\\"reference\\\". Essa informação nos permitirá criar um evento de recebimento de notificação para esse usuário.\",\n    \"5-3\": \"Mapeamento das merge variables utilizadas pelo template\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Observações\"\n}\n[/block]\n- Para enviar uma notificação deve-se passar os usuários que receberão a notificação, um mapeamento das variáveis utilizadas na notificação e o identificador do template previamente registrado que será utilizado.","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55b29bb91550ae0d003d98ad","__v":17,"project":"5538fb24dc5dd00d00e1da91","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5538fb25dc5dd00d00e1da95","5538feec27f8540d0024f00e","5547cbd3d3427d0d00cd6e2d","554a574f0b54d30d007fe0f9","55afbdbef202b12100cd9eeb","5c016f198e69b802d4385e25","5c81470b175ad6002457d9fa","5c81472e74fd5a0063420bae","5c81476b2dd69100430ea5a4"],"_id":"5538fb25dc5dd00d00e1da94","createdAt":"2015-04-23T14:01:09.040Z","project":"5538fb24dc5dd00d00e1da91","__v":9,"releaseDate":"2015-04-23T14:01:09.040Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["554a57af58f5650d00ae43d6","55a98a0602becf2d007aad8f","55a98bf45d3abb0d0012f2e7","55afbd9ad7624e3700e4f9f5","55afbdd2b3171b3700b1501e","55b29ab31550ae0d003d98a8","55b29b0d1550ae0d003d98aa","55b29bb91550ae0d003d98ad","55b29bdea74a380d00e29046","55b2a7efa74a380d00e29065","55b2a91ca74a380d00e29069"],"title":"APIs","slug":"apis","order":3,"from_sync":false,"reference":false,"_id":"554a574f0b54d30d007fe0f9","__v":11,"createdAt":"2015-05-06T18:02:55.085Z","project":"5538fb24dc5dd00d00e1da91","version":"5538fb25dc5dd00d00e1da94"},"createdAt":"2015-07-24T20:10:33.441Z","githubsync":"","editedParams":true,"editedParams2":true,"user":"556f85e29893290d00988dc5","parentDoc":null}

postEnviar notificação


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

identifier:
required
string
Identificador da notificação que será utilizada

Body Params

signature:
string
Assinatura (RSA com SECRET_KEY)
sha1_signature:
string
Assinatura (SHA1 com SECRET_KEY)
platform_api_key:
required
string
API KEY
encoding:
string
Codificação utilizada. Ex.: base64
users:
array of objects
Conjunto dos destinatários da notificação. Dentro de cada usuário, no nó 'vars' são enviadas as variáveis a serem utilizadas no e-mail.

Examples


Result Format


Documentation

Enviar uma notificação transacional [block:api-header] { "type": "basic", "title": "Parâmetros da URL" } [/block] [block:parameters] { "data": { "h-0": "Parâmetro", "h-1": "Obrigatório", "h-2": "Tipo", "h-3": "Descrição", "0-3": "Identificador da notificação que será utilizado", "0-0": "identifier", "0-2": "String", "0-1": "Sim" }, "cols": 4, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Parâmetros da requisição" } [/block] [block:parameters] { "data": { "h-0": "Parâmetro", "h-1": "Obrigatório", "h-2": "Tipo", "h-3": "Descrição", "0-0": "signature", "1-0": "sha1_signature", "2-0": "platform_api_key", "3-0": "encoding", "0-1": "Sim (Exceto se utilizar o sha1_signature)", "1-1": "Sim (Exceto se utilizar o signature)", "2-1": "Sim", "3-1": "Não", "3-2": "String", "2-2": "String", "1-2": "String", "0-2": "String", "0-3": "Assinatura gerada via RSA com a chave SECRET_KEY.", "1-3": "Assinatura gerada via SHA1 com a chave SECRET_KEY.", "2-3": "API_KEY do aplicativo.", "3-3": "Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).", "4-0": "users", "5-0": "vars", "4-1": "Sim", "5-1": "Não", "4-2": "Array of Objects", "5-2": "JSON", "4-3": "Conjunto de nomes e e-mails dos destinatários da notificação.\nOpcionalmente, poderá ser enviado no objeto do usuário o nó \"reference\". Essa informação nos permitirá criar um evento de recebimento de notificação para esse usuário.", "5-3": "Mapeamento das merge variables utilizadas pelo template" }, "cols": 4, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Observações" } [/block] - Para enviar uma notificação deve-se passar os usuários que receberão a notificação, um mapeamento das variáveis utilizadas na notificação e o identificador do template previamente registrado que será utilizado.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}