{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/portal/:id/signup","auth":"required","examples":{"codes":[{"name":null,"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  platform_api_key: 'SUA_API_KEY', \n  sha1_signature: signature,\n  encoding: 'base64',\n  user_data: {\n    name: 'USER_NAME',\n    email: 'USER_EMAIL',\n    gender: 'male', # male or female\n    location: 'Belo Horizonte',\n    birthday: '1993-09-20', #yyyy-mm-dd\n    created_at: '2015-06-01 08:23:14 -0300', #yyyy-mm-dd hh:mm:ss -z\n    data: { extra: \"EXTRA_DATA\" }.to_json\n  }\n}\n\nHTTParty.post(\"https://login.plataformasocial.com.br/users/portal/#{id}/signup\", body: params)\n","language":"ruby"}]},"method":"post","params":[{"name":"id","type":"string","default":"","desc":"ID do usuário. Ex.: CPF do usuário (somente números); SHA1 do e-mail do usuário; etc","required":true,"in":"path","ref":"","_id":"55a98b2c5d3abb0d0012f2e3"},{"name":"signature","type":"string","default":"","desc":"Assinatura (RSA com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55a98b2c5d3abb0d0012f2e6"},{"name":"sha1_signature","type":"string","default":"","desc":"Assinatura (SHA1 com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55afd4c0f202b12100cd9f85"},{"name":"platform_api_key","type":"string","default":"","desc":"API KEY","required":true,"in":"body","ref":"","_id":"55a98b2c5d3abb0d0012f2e5"},{"name":"user_data","type":"object","default":"","desc":"Objeto com os dados do usuário","required":false,"in":"body","ref":"","_id":"5d6d792a63a02c0056596ebf"},{"name":"user_data[name]","type":"string","default":"","desc":"Nome do usuário","required":false,"in":"body","ref":"","_id":"55a98b2c5d3abb0d0012f2e1"},{"name":"user_data[email]","type":"string","default":"","desc":"E-mail do usuário","required":false,"in":"body","ref":"","_id":"55a98b2c5d3abb0d0012f2e0"},{"name":"user_data[gender]","type":"string","default":"","desc":"Gênero do usuário (Deve ser \"male\" ou \"female\")","required":false,"in":"body","ref":"","_id":"5b620925546cff0003d02d03"},{"name":"user_data[location]","type":"string","default":"","desc":"Cidade do usuário. (Ex: \"Belo Horizonte\")","required":false,"in":"body","ref":"","_id":"5b620925546cff0003d02d02"},{"name":"user_data[birthday]","type":"string","default":"","desc":"Data de nascimento do usuário. Formato YYYY-MM-DD","required":false,"in":"body","ref":"","_id":"5b620925546cff0003d02d01"},{"name":"user_data[created_at]","type":"string","default":"","desc":"Data de cadastro do usuário em sua base de dados. Se não enviada, a data atual será considerada.","required":false,"in":"body","ref":"","_id":"5b620925546cff0003d02d00"},{"name":"user_data[data]","type":"string","default":"","desc":"String JSON com os dados customizados. Ex: {\"cep\":\"30000-120\"}","required":false,"in":"body","ref":"","_id":"55a98b2c5d3abb0d0012f2df"}],"results":{"codes":[]},"settings":"55afbd32d7624e3700e4f9f2"},"next":{"description":"","pages":[]},"title":"Registrar usuário","type":"endpoint","slug":"registro-do-usuário","excerpt":"","body":"Registro do usuário na API\n\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    \"0-0\": \"id\",\n    \"h-0\": \"Parâmetro\",\n    \"h-1\": \"Obrigatório\",\n    \"h-2\": \"Tipo\",\n    \"h-3\": \"Descrição\",\n    \"0-1\": \"Sim\",\n    \"0-2\": \"String\",\n    \"0-3\": \"ID do usuário na rede social\"\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\": \"signature\",\n    \"2-0\": \"platform_api_key\",\n    \"0-1\": \"Sim (Exceto se utilizar o sha1_signature)\",\n    \"2-1\": \"Sim\",\n    \"0-2\": \"String\",\n    \"2-2\": \"String\",\n    \"0-4\": \"\",\n    \"2-4\": \"\",\n    \"0-3\": \"Assinatura gerada via RSA com a chave SECRET_KEY.\",\n    \"2-3\": \"API_KEY do aplicativo.\",\n    \"4-0\": \"user_data\",\n    \"5-0\": \"user_data.data\",\n    \"4-1\": \"Não\",\n    \"5-1\": \"Não\",\n    \"5-2\": \"String (com formatação de JSON)\",\n    \"4-2\": \"JSON\",\n    \"4-3\": \"JSON contendo os dados do usuário. Normalmente esse parâmetro é usado com a rede \\\"portal\\\". Dados: name, email, gender, location, birthday e created_at.\",\n    \"5-3\": \"String em formato de JSON contendo os dados customizados do usuário. Esses parâmetros são usado em todas as redes de cadastro do usuário. Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente.\",\n    \"4-4\": \"\",\n    \"5-4\": \"\",\n    \"3-0\": \"encoding\",\n    \"3-1\": \"Não\",\n    \"3-2\": \"String\",\n    \"3-3\": \"Codificação utilizada para a assinatura (base64 ou nenhuma codificação). Ex.: base64.\",\n    \"3-4\": \"\",\n    \"1-0\": \"sha1_signature\",\n    \"1-1\": \"Sim (Exceto se utilizar o signature)\",\n    \"1-4\": \"\",\n    \"1-2\": \"String\",\n    \"1-3\": \"Assinatura gerada via SHA1 com a chave SECRET_KEY.\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\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      \\\"reference\\\" : \\\"XXXXXXXXXX\\\"\\n    }\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55a98a0602becf2d007aad8f","user":"556f85e29893290d00988dc5","__v":30,"editedParams2":true,"githubsync":"","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,"createdAt":"2015-07-17T23:04:38.887Z","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"},"parentDoc":null}

postRegistrar usuário


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
ID do usuário. Ex.: CPF do usuário (somente números); SHA1 do e-mail do usuário; etc

Body Params

signature:
string
Assinatura (RSA com SECRET_KEY)
sha1_signature:
string
Assinatura (SHA1 com SECRET_KEY)
platform_api_key:
required
string
API KEY
user_data:
object
Objeto com os dados do usuário
user_data[name]:
string
Nome do usuário
user_data[email]:
string
E-mail do usuário
user_data[gender]:
string
Gênero do usuário (Deve ser "male" ou "female")
user_data[location]:
string
Cidade do usuário. (Ex: "Belo Horizonte")
user_data[birthday]:
string
Data de nascimento do usuário. Formato YYYY-MM-DD
user_data[created_at]:
string
Data de cadastro do usuário em sua base de dados. Se não enviada, a data atual será considerada.
user_data[data]:
string
String JSON com os dados customizados. Ex: {"cep":"30000-120"}

Examples


Documentation

Registro do 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": { "0-0": "id", "h-0": "Parâmetro", "h-1": "Obrigatório", "h-2": "Tipo", "h-3": "Descrição", "0-1": "Sim", "0-2": "String", "0-3": "ID do usuário na rede social" }, "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": "signature", "2-0": "platform_api_key", "0-1": "Sim (Exceto se utilizar o sha1_signature)", "2-1": "Sim", "0-2": "String", "2-2": "String", "0-4": "", "2-4": "", "0-3": "Assinatura gerada via RSA com a chave SECRET_KEY.", "2-3": "API_KEY do aplicativo.", "4-0": "user_data", "5-0": "user_data.data", "4-1": "Não", "5-1": "Não", "5-2": "String (com formatação de JSON)", "4-2": "JSON", "4-3": "JSON contendo os dados do usuário. Normalmente esse parâmetro é usado com a rede \"portal\". Dados: name, email, gender, location, birthday e created_at.", "5-3": "String em formato de JSON contendo os dados customizados do usuário. Esses parâmetros são usado em todas as redes de cadastro do usuário. Veja os [formatos de datas suportados](formato-de-datas) para ver como enviar datas e horários corretamente.", "4-4": "", "5-4": "", "3-0": "encoding", "3-1": "Não", "3-2": "String", "3-3": "Codificação utilizada para a assinatura (base64 ou nenhuma codificação). Ex.: base64.", "3-4": "", "1-0": "sha1_signature", "1-1": "Sim (Exceto se utilizar o signature)", "1-4": "", "1-2": "String", "1-3": "Assinatura gerada via SHA1 com a chave SECRET_KEY." }, "cols": 4, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Exemplo de Retorno" } [/block] [block:code] { "codes": [ { "code": " {\n \"data\" : {\n \"reference\" : \"XXXXXXXXXX\"\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 }}