{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id","auth":"required","results":{"codes":[]},"settings":"55afbd32d7624e3700e4f9f2","examples":{"codes":[{"language":"ruby","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  user_data: {\n    name: 'USER_NAME',\n    email: 'USER_EMAIL',\n    data: { extra: \"EXTRA_DATA\" }.to_json\n  }\n}\n\nHTTParty.put(\"https://login.plataformasocial.com.br/users/#{id}\", body: params)\n","name":""}]},"method":"put","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":"55afc607f202b12100cd9f2d"},{"name":"id_type","type":"string","default":"","desc":"Neste campo deve ser enviado uma string com o valor \"id\"","required":true,"in":"body","ref":"","_id":"55afc607f202b12100cd9f2e"},{"name":"signature","type":"string","default":"","desc":"Assinatura (RSA com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55afc607f202b12100cd9f32"},{"name":"sha1_signature","type":"string","default":"","desc":"Assinatura (SHA1 com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b136edb2405537003cd9eb"},{"name":"platform_api_key","type":"string","default":"","desc":"API KEY","required":true,"in":"body","ref":"","_id":"55afc607f202b12100cd9f31"},{"name":"network_name","type":"string","default":"","desc":"Neste campo deve ser enviado uma string com o valor \"pt\"","required":true,"in":"body","ref":"","_id":"55afc607f202b12100cd9f2f"},{"name":"encoding","type":"string","default":"","desc":"Codificação utilizada. Ex.: base64","required":false,"in":"body","ref":"","_id":"55afc607f202b12100cd9f30"},{"name":"user_data[name]","type":"string","default":"","desc":"Nome do usuário","required":false,"in":"body","ref":"","_id":"55afc607f202b12100cd9f2c"},{"name":"user_data[email]","type":"string","default":"","desc":"E-mail do usuário","required":false,"in":"body","ref":"","_id":"55afc607f202b12100cd9f2b"},{"name":"user_data[data]","type":"string","default":"","desc":"Dados extras. Ex: {\"id\":\"123\"}","required":false,"in":"body","ref":"","_id":"55afc607f202b12100cd9f2a"}]},"next":{"description":"","pages":[]},"title":"Atualizar usuário","type":"endpoint","slug":"atualizar-o-usuário","excerpt":"","body":"Atualiza o usuário na API.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"ATENÇÃO!\",\n  \"body\": \"Os nomes das propriedades dos usuários 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    \"h-1\": \"Obrigatório\",\n    \"h-2\": \"Tipo\",\n    \"h-3\": \"Descrição\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Sim\",\n    \"0-2\": \"String\",\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    \"0-1\": \"Sim\",\n    \"0-2\": \"String\",\n    \"0-3\": \"Neste campo deve ser enviado uma string com o valor \\\"id\\\".\",\n    \"0-4\": \"\",\n    \"1-0\": \"signature\",\n    \"2-0\": \"sha1_signature\",\n    \"1-1\": \"Sim (Exceto se utilizar o sha1_signature)\",\n    \"2-1\": \"Sim (Exceto se utilizar o signature)\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"1-3\": \"Assinatura gerada via RSA com a chave SECRET_KEY.\",\n    \"2-3\": \"Assinatura gerada via SHA1 com a chave SECRET_KEY.\",\n    \"1-4\": \"\",\n    \"2-4\": \"\",\n    \"3-0\": \"platform_api_key\",\n    \"4-0\": \"network_name\",\n    \"5-0\": \"encoding\",\n    \"3-1\": \"Sim\",\n    \"4-1\": \"Sim\",\n    \"5-1\": \"Não\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\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    \"3-4\": \"\",\n    \"4-4\": \"\",\n    \"5-4\": \"\",\n    \"6-0\": \"user_data\",\n    \"7-0\": \"user_data.data\",\n    \"6-1\": \"Não\",\n    \"7-1\": \"Não\",\n    \"6-2\": \"JSON\",\n    \"7-2\": \"String (com formatação de JSON)\",\n    \"6-4\": \"\",\n    \"7-4\": \"\",\n    \"7-3\": \"String em formato de JSON contendo os dados do usuário. \\nNormalmente esse parâmetro é usado com a rede \\\"portal\\\". Dados: name, email, gender, birthday, location e data (dados extras). Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente.\",\n    \"6-3\": \"JSON contendo os dados do usuário. Normalmente esse parâmetro é usado com a rede \\\"portal\\\". Dados: name, email, gender, birthday, location.\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\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      \\\"user\\\": {\\n        \\\"location\\\": {\\n          \\\"id\\\": \\\"106280439410017\\\",\\n          \\\"name\\\": \\\"Belo Horizonte, Brazil\\\"\\n        },\\n        \\\"gender\\\": \\\"male\\\",\\n        \\\"verified\\\": \\\"true\\\",\\n        \\\"id\\\": \\\"123456789\\\",\\n        \\\"name\\\": \\\"Marcos Nogueira\\\",\\n        \\\"email\\\": \\\"marcos:::at:::example.com\\\",\\n        \\\"birthday\\\": \\\"02/03/1990\\\"\\n      }\\n    }\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55afbdd2b3171b3700b1501e","githubsync":"","project":"5538fb24dc5dd00d00e1da91","__v":12,"createdAt":"2015-07-22T15:59:14.769Z","editedParams2":true,"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"},"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"},"editedParams":true,"user":"556f85e29893290d00988dc5","parentDoc":null}

putAtualizar 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
user_data[name]:
string
Nome do usuário
user_data[email]:
string
E-mail do usuário
user_data[data]:
string
Dados extras. Ex: {"id":"123"}

Examples


Documentation

Atualiza o usuário na API. [block:callout] { "type": "danger", "title": "ATENÇÃO!", "body": "Os nomes das propriedades dos usuários 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", "h-1": "Obrigatório", "h-2": "Tipo", "h-3": "Descrição", "0-0": "id", "0-1": "Sim", "0-2": "String", "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", "0-1": "Sim", "0-2": "String", "0-3": "Neste campo deve ser enviado uma string com o valor \"id\".", "0-4": "", "1-0": "signature", "2-0": "sha1_signature", "1-1": "Sim (Exceto se utilizar o sha1_signature)", "2-1": "Sim (Exceto se utilizar o signature)", "1-2": "String", "2-2": "String", "1-3": "Assinatura gerada via RSA com a chave SECRET_KEY.", "2-3": "Assinatura gerada via SHA1 com a chave SECRET_KEY.", "1-4": "", "2-4": "", "3-0": "platform_api_key", "4-0": "network_name", "5-0": "encoding", "3-1": "Sim", "4-1": "Sim", "5-1": "Não", "3-2": "String", "4-2": "String", "5-2": "String", "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).", "3-4": "", "4-4": "", "5-4": "", "6-0": "user_data", "7-0": "user_data.data", "6-1": "Não", "7-1": "Não", "6-2": "JSON", "7-2": "String (com formatação de JSON)", "6-4": "", "7-4": "", "7-3": "String em formato de JSON contendo os dados do usuário. \nNormalmente esse parâmetro é usado com a rede \"portal\". Dados: name, email, gender, birthday, location e data (dados extras). Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente.", "6-3": "JSON contendo os dados do usuário. Normalmente esse parâmetro é usado com a rede \"portal\". Dados: name, email, gender, birthday, location." }, "cols": 4, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Exemplo de Retorno" } [/block] [block:code] { "codes": [ { "code": " {\n \"data\": {\n \"user\": {\n \"location\": {\n \"id\": \"106280439410017\",\n \"name\": \"Belo Horizonte, Brazil\"\n },\n \"gender\": \"male\",\n \"verified\": \"true\",\n \"id\": \"123456789\",\n \"name\": \"Marcos Nogueira\",\n \"email\": \"[email protected]\",\n \"birthday\": \"02/03/1990\"\n }\n }\n }", "language": "json" } ] } [/block]

User Information

Try It Out

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