{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id","auth":"required","results":{"codes":[]},"settings":"55a93cf502becf2d007aac4a","examples":{"codes":[{"code":"# Exemplo em Ruby\n\nrequire 'digest/sha1'\nrequire 'httparty'\nrequire 'json'\n\nsignature = Digest::SHA1.hexdigest('SUA_SECRET_KEY')\nid = 'ID_DO_SEU_USUARIO'\n\nparams = {\n  id_type: 'id',\n  platform_api_key: 'SUA_API_KEY', \n  sha1_signature: signature,\n  encoding: 'base64',\n  network_name: 'pt',\n  event: { \n    action: 'nome-do-evento', \n    revenue: 10.12, \n    created_at: '2015-06-22 19:21:18 -0300', #yyyy-mm-dd hh:mm:ss -z\n    data: { cor: 'azul' }\n  }.to_json\n}\n\nHTTParty.post(\"http://events.plataformasocial.com.br/users/#{id}\", body: params)\n","language":"ruby","name":""}]},"method":"post","params":[{"name":"id","type":"string","default":"","desc":"Identificador do usuário na Dito. Ex.: CPF do usuário (somente números), SHA1 do e-mail, ID do banco de dados.","required":true,"in":"path","ref":"","_id":"55a98eb34c661b3700cf4f20"},{"name":"id_type","type":"string","default":"","desc":"Neste campo deve ser enviado uma string com o valor \"id\"","required":true,"in":"body","ref":"","_id":"55afc15df202b12100cd9f09"},{"name":"signature","type":"string","default":"","desc":"Assinatura (RSA com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55a98eb34c661b3700cf4f23"},{"name":"sha1_signature","type":"string","default":"","desc":"Assinatura (SHA1 com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b148ceb2405537003cda40"},{"name":"platform_api_key","type":"string","default":"","desc":"API KEY","required":true,"in":"body","ref":"","_id":"55a98eb34c661b3700cf4f22"},{"name":"network_name","type":"string","default":"","desc":"Neste campo deve ser enviado uma string com o valor \"pt\"","required":true,"in":"body","ref":"","_id":"55b14da6b3a7e037008ac219"},{"name":"encoding","type":"string","default":"","desc":"Codificação utilizada. Ex.: base64","required":false,"in":"body","ref":"","_id":"55a98eb34c661b3700cf4f21"},{"name":"event","type":"string","default":"","desc":"String JSON dos dados do evento","required":false,"in":"body","ref":"","_id":"55a98eb34c661b3700cf4f1f"},{"name":"event[action]","type":"string","default":"","desc":"Novo do evento Ex.: comprou","required":true,"in":"body","ref":"","_id":"5d6d7a997ba821005ef3cc01"},{"name":"event[created_at]","type":"string","default":"","desc":"Data de ocorrência do evento no formato YYYY-MM-DD HH:MM:SS. Se não enviada, a data atual será considerada.","required":false,"in":"body","ref":"","_id":"5d6d7a997ba821005ef3cc00"},{"name":"event[revenue]","type":"float","default":"","desc":"Campo com o valor monetário do evento, caso o evento gere receita. Se o evento não tiver receita não mande esse campo.","required":false,"in":"body","ref":"","_id":"5d6d7a997ba821005ef3cbff"},{"name":"event[data]","type":"object","default":"","desc":"Dados customizados. Ex: {\"id_transacao\":\"000001\"}","required":false,"in":"body","ref":"","_id":"5d6d7a997ba821005ef3cbfe"}]},"next":{"description":"","pages":[]},"title":"Trackear usuário","type":"endpoint","slug":"track-do-usuário","excerpt":"","body":"Track do usuário na API.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"ATENÇÃO!\",\n  \"body\": \"Os nomes dos eventos **DEVEM** ser enviados para a Dito em letras minúsculas, sem acentuação ou caracteres especiais. Caso o nome de suas ações seja composto por mais de uma palavra, estas devem ser separadas por hífen '-'.\\n\\n**Exemplo:**\\nmeu-evento-1\\nmeu-evento-2\\n\\nOs nomes das propriedades dos eventos enviados dentro do nó *data* **DEVEM** estar em letras minúsculas, sem acentuação ou caracteres especiais. Caso o nome de suas propriedades seja composto por mais de uma palavra, estas devem ser separadas por underscore '_' no padrão snake case.\\n\\n**Exemplo:**\\nminha_propriedade_1\\nminha_propriedade_2\"\n}\n[/block]\n\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    \"0-0\": \"id\",\n    \"h-1\": \"Obrigatório\",\n    \"0-1\": \"Sim\",\n    \"h-2\": \"Tipo\",\n    \"0-2\": \"String\",\n    \"h-3\": \"Descrição\",\n    \"0-3\": \"Identificador do usuário na Dito. Ex.: CPF do usuário (somente números), SHA1 do e-mail, ID do banco de dados.\"\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    \"h-4\": \"\",\n    \"0-0\": \"id_type\",\n    \"1-0\": \"signature\",\n    \"2-0\": \"sha1_signature\",\n    \"3-0\": \"platform_api_key\",\n    \"4-0\": \"network_name\",\n    \"5-0\": \"encoding\",\n    \"6-0\": \"event\",\n    \"0-1\": \"Sim\",\n    \"1-1\": \"Sim (Exceto se utilizar o sha1_signature)\",\n    \"2-1\": \"Sim (Exceto se utilizar o signature)\",\n    \"3-1\": \"Sim\",\n    \"4-1\": \"Sim\",\n    \"5-1\": \"Não\",\n    \"6-1\": \"Sim\",\n    \"6-2\": \"String (com formatação de JSON)\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"1-3\": \"Assinatura gerada via RSA com a chave SECRET_KEY.\",\n    \"1-4\": \"\",\n    \"2-4\": \"\",\n    \"2-3\": \"Assinatura gerada via SHA1 com a chave SECRET_KEY.\",\n    \"3-3\": \"API_KEY do aplicativo.\",\n    \"4-3\": \"Neste campo deve ser enviado uma string com o valor \\\"pt\\\".\",\n    \"5-3\": \"Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).\",\n    \"0-3\": \"Neste campo deve ser enviado uma string com o valor \\\"id\\\".\",\n    \"6-3\": \"Dados do evento a ser trackeado na plataforma Dito. É informado três valores: \\n* **action (Obrigatório):**  Nome da ação que o usuário está fazendo;\\n* **revenue :** Caso o evento tenha gerado uma receita para o aplicativo/ambiente trackeado essa receita/valor financeiro deve ser enviada nesse campo;\\n* **created_at (Opcional): **\\nData e hora em que o evento aconteceu. Caso não seja informado, a data/hora atual será considerada.\\n* **data (Opcional):** Dados do evento que devem ser armazenados, mas que não se encaixam nos outros campos. Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente.\"\n  },\n  \"cols\": 4,\n  \"rows\": 7\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exemplo de Retorno\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"  {\\n    \\\"data\\\": [{\\n      \\\"data\\\": {\\n        \\\"filme_id\\\": '59',\\n        \\\"filme_titulo\\\": 'Wolverine: Imortal',\\n        \\\"filme_thumb\\\": 'http://ia.media-imdb.com/images/M/MV5BNzg1MDQxMTQ2OF5BMl5BanBnXkFtZTcwMTk3MjAzOQ:::at:::@._V1_SX214_.jpg',\\n        \\\"year\\\": \\\"2013\\\",\\n        \\\"rating\\\": \\\"PG-13\\\"\\n      },\\n      \\\"revenue\\\": 5.99,\\n      \\\"feedable\\\": true,\\n      \\\"shareable\\\": true,\\n      \\\"referrer\\\": \\\"http://apps.facebook.com/ingresso_staging/\\\",\\n      \\\"referral_code\\\": null,\\n      \\\"reference\\\": \\\"XXXXXXXXXX\\\",\\n      \\\"created_at\\\": \\\"2013-11-27T11:28:32-02:00\\\",\\n      \\\"id\\\": 27,\\n      \\\"action\\\": \\\"watch\\\",\\n      \\\"utm\\\": {\\n        \\\"source\\\": \\\"direct\\\"\\n      },\\n      \\\"origin\\\": {\\n        \\\"signin_count\\\": 2,\\n        \\\"signup_count\\\": 0,\\n        \\\"shares_count\\\": 1,\\n        \\\"revenue\\\": 5.99,\\n        \\\"clicks_count\\\": 1\\n      },\\n      \\\"user\\\": {\\n        \\\"picture_url\\\": \\\"http://graph.facebook.com/XXXXXXXXXX/picture?type=square\\\",\\n        \\\"reference\\\": \\\"XXXXXXXXXX\\\",\\n        \\\"networks\\\": {\\n          \\\"facebook\\\": {\\n            \\\"name\\\": \\\"Marcos Nogueira\\\",\\n            \\\"link\\\": \\\"http://www.facebook.com/profile.php?id=XXXXXXXXXX\\\",\\n            \\\"social_id\\\": \\\"XXXXXXXXXX\\\",\\n            \\\"picture_url\\\": \\\"http://graph.facebook.com/XXXXXXXXXX/picture?type=square\\\"\\n          }\\n        }\\n      }\\n    }]\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55a98bf45d3abb0d0012f2e7","githubsync":"","project":"5538fb24dc5dd00d00e1da91","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-17T23:12:52.381Z","editedParams":true,"user":"556f85e29893290d00988dc5","__v":21,"editedParams2":true,"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"},"parentDoc":null}

postTrackear usuário


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
Identificador do usuário na Dito. Ex.: CPF do usuário (somente números), SHA1 do e-mail, ID do banco de dados.

Body Params

id_type:
required
string
Neste campo deve ser enviado uma string com o valor "id"
signature:
string
Assinatura (RSA com SECRET_KEY)
sha1_signature:
string
Assinatura (SHA1 com SECRET_KEY)
platform_api_key:
required
string
API KEY
network_name:
required
string
Neste campo deve ser enviado uma string com o valor "pt"
encoding:
string
Codificação utilizada. Ex.: base64
event:
string
String JSON dos dados do evento
event[action]:
required
string
Novo do evento Ex.: comprou
event[created_at]:
string
Data de ocorrência do evento no formato YYYY-MM-DD HH:MM:SS. Se não enviada, a data atual será considerada.
event[revenue]:
float
Campo com o valor monetário do evento, caso o evento gere receita. Se o evento não tiver receita não mande esse campo.
event[data]:
object
Dados customizados. Ex: {"id_transacao":"000001"}

Examples


Documentation

Track do usuário na API. [block:callout] { "type": "danger", "title": "ATENÇÃO!", "body": "Os nomes dos eventos **DEVEM** ser enviados para a Dito em letras minúsculas, sem acentuação ou caracteres especiais. Caso o nome de suas ações seja composto por mais de uma palavra, estas devem ser separadas por hífen '-'.\n\n**Exemplo:**\nmeu-evento-1\nmeu-evento-2\n\nOs nomes das propriedades dos eventos enviados dentro do nó *data* **DEVEM** estar em letras minúsculas, sem acentuação ou caracteres especiais. Caso o nome de suas propriedades seja composto por mais de uma palavra, estas devem ser separadas por underscore '_' no padrão snake case.\n\n**Exemplo:**\nminha_propriedade_1\nminha_propriedade_2" } [/block] [block:api-header] { "type": "basic", "title": "Parâmetros da URL" } [/block] [block:parameters] { "data": { "h-0": "Parâmetro", "0-0": "id", "h-1": "Obrigatório", "0-1": "Sim", "h-2": "Tipo", "0-2": "String", "h-3": "Descrição", "0-3": "Identificador do usuário na Dito. Ex.: CPF do usuário (somente números), SHA1 do e-mail, ID do banco de dados." }, "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", "h-4": "", "0-0": "id_type", "1-0": "signature", "2-0": "sha1_signature", "3-0": "platform_api_key", "4-0": "network_name", "5-0": "encoding", "6-0": "event", "0-1": "Sim", "1-1": "Sim (Exceto se utilizar o sha1_signature)", "2-1": "Sim (Exceto se utilizar o signature)", "3-1": "Sim", "4-1": "Sim", "5-1": "Não", "6-1": "Sim", "6-2": "String (com formatação de JSON)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "1-3": "Assinatura gerada via RSA com a chave SECRET_KEY.", "1-4": "", "2-4": "", "2-3": "Assinatura gerada via SHA1 com a chave SECRET_KEY.", "3-3": "API_KEY do aplicativo.", "4-3": "Neste campo deve ser enviado uma string com o valor \"pt\".", "5-3": "Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).", "0-3": "Neste campo deve ser enviado uma string com o valor \"id\".", "6-3": "Dados do evento a ser trackeado na plataforma Dito. É informado três valores: \n* **action (Obrigatório):** Nome da ação que o usuário está fazendo;\n* **revenue :** Caso o evento tenha gerado uma receita para o aplicativo/ambiente trackeado essa receita/valor financeiro deve ser enviada nesse campo;\n* **created_at (Opcional): **\nData e hora em que o evento aconteceu. Caso não seja informado, a data/hora atual será considerada.\n* **data (Opcional):** Dados do evento que devem ser armazenados, mas que não se encaixam nos outros campos. Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente." }, "cols": 4, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "Exemplo de Retorno" } [/block] [block:code] { "codes": [ { "code": " {\n \"data\": [{\n \"data\": {\n \"filme_id\": '59',\n \"filme_titulo\": 'Wolverine: Imortal',\n \"filme_thumb\": 'http://ia.media-imdb.com/images/M/[email protected]@._V1_SX214_.jpg',\n \"year\": \"2013\",\n \"rating\": \"PG-13\"\n },\n \"revenue\": 5.99,\n \"feedable\": true,\n \"shareable\": true,\n \"referrer\": \"http://apps.facebook.com/ingresso_staging/\",\n \"referral_code\": null,\n \"reference\": \"XXXXXXXXXX\",\n \"created_at\": \"2013-11-27T11:28:32-02:00\",\n \"id\": 27,\n \"action\": \"watch\",\n \"utm\": {\n \"source\": \"direct\"\n },\n \"origin\": {\n \"signin_count\": 2,\n \"signup_count\": 0,\n \"shares_count\": 1,\n \"revenue\": 5.99,\n \"clicks_count\": 1\n },\n \"user\": {\n \"picture_url\": \"http://graph.facebook.com/XXXXXXXXXX/picture?type=square\",\n \"reference\": \"XXXXXXXXXX\",\n \"networks\": {\n \"facebook\": {\n \"name\": \"Marcos Nogueira\",\n \"link\": \"http://www.facebook.com/profile.php?id=XXXXXXXXXX\",\n \"social_id\": \"XXXXXXXXXX\",\n \"picture_url\": \"http://graph.facebook.com/XXXXXXXXXX/picture?type=square\"\n }\n }\n }\n }]\n }", "language": "json" } ] } [/block]

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 }}