{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/:id/mobile-tokens/disable/","auth":"required","examples":{"codes":[{"language":"ruby","code":"# Exemplo em Ruby\n\nrequire 'digest/sha1'\nrequire 'httparty'\n\napi_key = 'SUA_API_KEY'\nsecret = 'SUA_SECRET'\n\nid = \"ID_DO_SEU_USUARIO\"\n\nsignature = Digest::SHA1.hexdigest(secret)\n\nparams = {\n  id_type: \"id\",\n  platform_api_key: api_key, \n  sha1_signature: signature,\n  token: \"TOKEN_DISPOSITIVO_MOVEL\",\n  platform: \"PLATAFORMA_DO_USUARIO\"\n}\n\nHTTParty.post(\"https://notification.plataformasocial.com.br/users/#{id}/mobile-tokens/disable\", body: params)","name":""}]},"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":"55b7990331bccb190081bfdb"},{"name":"id_type","type":"string","default":"","desc":"Neste campo deve ser enviado uma string com o valor \"id\"","required":true,"in":"body","ref":"","_id":"55b7990331bccb190081bfda"},{"name":"signature","type":"string","default":"","desc":"Assinatura (RSA com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b7990331bccb190081bfd9"},{"name":"sha1_signature","type":"string","default":"","desc":"Assinatura (SHA1 com SECRET_KEY)","required":false,"in":"body","ref":"","_id":"55b7990331bccb190081bfd8"},{"name":"platform_api_key","type":"string","default":"","desc":"API KEY","required":true,"in":"body","ref":"","_id":"55b7990331bccb190081bfd7"},{"name":"encoding","type":"string","default":"","desc":"Codificação utilizada. Ex.: base64","required":false,"in":"body","ref":"","_id":"55b7990331bccb190081bfd6"},{"name":"token","type":"string","default":"","desc":"Token do dispositivo móvel do usuário","required":false,"in":"body","ref":"","_id":"55b7990331bccb190081bfd5"},{"name":"platform","type":"string","default":"","desc":"Plataforma que o usuário está acessando ao aplicativo. Opções: Apple iPhone e Android","required":false,"in":"body","ref":"","_id":"55b7990331bccb190081bfd4"}],"results":{"codes":[]},"settings":"55b29c106862a10d00887a8c"},"next":{"description":"","pages":[]},"title":"Desativar token mobile","type":"endpoint","slug":"desativar-token-mobile","excerpt":"","body":"Desativar o token do mobile cadastrado para o usuário.\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    \"0-1\": \"Sim\",\n    \"0-2\": \"String\",\n    \"h-3\": \"Descrição\",\n    \"0-3\": \"ID do usuário. Ex.: CPF do usuário (somente números); SHA1 do e-mail do usuário; etc\"\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\": \"id_type\",\n    \"1-0\": \"signature\",\n    \"2-0\": \"sha1_signature\",\n    \"3-0\": \"platform_api_key\",\n    \"4-0\": \"encoding\",\n    \"5-0\": \"token\",\n    \"6-0\": \"platform\",\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\": \"Não\",\n    \"5-1\": \"Sim\",\n    \"6-1\": \"Sim\",\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    \"6-2\": \"String\",\n    \"0-3\": \"Neste campo deve ser enviado uma string com o valor \\\"id\\\"\",\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    \"3-3\": \"API_KEY do aplicativo.\",\n    \"4-3\": \"Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).\",\n    \"5-3\": \"Token do dispositivo móvel do usuário\",\n    \"6-3\": \"Nome da plataforma que o usuário está acessando ao aplicativo.\\nOpções: Apple iPhone e Android\"\n  },\n  \"cols\": 4,\n  \"rows\": 7\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exemplo de Retorno (Sucesso)\"\n}\n[/block]\nA resposta de sucesso é um JSON com o nó data contendo o TOKEN enviado.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"  {\\n    \\\"data\\\": {\\n      \\\"token\\\": \\\"TOKEN_ENVIADO\\\"\\n    }\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exemplo de Retorno (Erro)\"\n}\n[/block]\nA resposta retornada é um JSON contendo o nó error. Dentro desse nó error existe um objeto que possui o código http retornado, o código do erro na plataforma da Dito, o tipo do erro na plataforma da dito e uma mensagem explicativa.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"  {\\n    \\\"error\\\": {\\n      \\\"status\\\": 404,\\n      \\\"code\\\": \\\"U1\\\",\\n      \\\"type\\\": \\\"userNotFound\\\",\\n      \\\"message\\\": \\\"User not found\\\"\\n    }\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55b2a91ca74a380d00e29069","__v":6,"createdAt":"2015-07-24T21:07:40.728Z","editedParams2":true,"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"},"editedParams":true,"user":"556f85e29893290d00988dc5","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"},"githubsync":"","parentDoc":null}

postDesativar token mobile


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

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
encoding:
string
Codificação utilizada. Ex.: base64
token:
string
Token do dispositivo móvel do usuário
platform:
string
Plataforma que o usuário está acessando ao aplicativo. Opções: Apple iPhone e Android

Examples


Documentation

Desativar o token do mobile cadastrado para o usuário. [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", "0-1": "Sim", "0-2": "String", "h-3": "Descrição", "0-3": "ID do usuário. Ex.: CPF do usuário (somente números); SHA1 do e-mail do usuário; etc" }, "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": "id_type", "1-0": "signature", "2-0": "sha1_signature", "3-0": "platform_api_key", "4-0": "encoding", "5-0": "token", "6-0": "platform", "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": "Não", "5-1": "Sim", "6-1": "Sim", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "0-3": "Neste campo deve ser enviado uma string com o valor \"id\"", "1-3": "Assinatura gerada via RSA com a chave SECRET_KEY.", "2-3": "Assinatura gerada via SHA1 com a chave SECRET_KEY.", "3-3": "API_KEY do aplicativo.", "4-3": "Codificação utilizada para a assinatura (base64 ou nenhuma codificação se não informado).", "5-3": "Token do dispositivo móvel do usuário", "6-3": "Nome da plataforma que o usuário está acessando ao aplicativo.\nOpções: Apple iPhone e Android" }, "cols": 4, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "Exemplo de Retorno (Sucesso)" } [/block] A resposta de sucesso é um JSON com o nó data contendo o TOKEN enviado. [block:code] { "codes": [ { "code": " {\n \"data\": {\n \"token\": \"TOKEN_ENVIADO\"\n }\n }", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Exemplo de Retorno (Erro)" } [/block] A resposta retornada é um JSON contendo o nó error. Dentro desse nó error existe um objeto que possui o código http retornado, o código do erro na plataforma da Dito, o tipo do erro na plataforma da dito e uma mensagem explicativa. [block:code] { "codes": [ { "code": " {\n \"error\": {\n \"status\": 404,\n \"code\": \"U1\",\n \"type\": \"userNotFound\",\n \"message\": \"User not found\"\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 }}