Agregadores y PSPaaS
Gestión de Usuarios
3 min
con el siguiente conjunto de api's podrán ser gestionados los usuarios que posee un operador dentro de suga { "name" "alta de usuario", "method" "post", "url" "https //{suga id} sugaway io/p/operator/user", "description" "este endpoint permite gestionar el alta de un usuario de la plataforma para poder ser luego asignado dentro de un comercio", "tab" "examples", "examples" { "languages" \[ { "id" "mccdn9xclxes4 huev01x", "language" "curl", "code" "curl location globoff 'https //{suga id} sugaway io/p/operator/user' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\\"name\\" \\"string\\",\\"email\\" \\"string\\",\\"phone\\" \\"string\\",\\"identification\\" \\"string\\"}'", "customlabel" "" }, { "id" "zc4ntftsgez7oziwfhydm", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //{suga id} sugaway io/p/operator/user',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\",\n \\"identification\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "7stzogfjeo2guchdgtj1k", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\",\n \\"identification\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //{suga id} sugaway io/p/operator/user\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "szyrbcc8ceajop9lm7elm", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //{suga id} sugaway io/p/operator/user\\"\n\npayload = json dumps({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\",\n \\"identification\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "c3s730h2 hl4vjbjiwl89", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //{suga id} sugaway io/p/operator/user\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\",\n \\"identification\\" \\"string\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "mccdn9xclxes4 huev01x" }, "results" { "languages" \[ { "id" "oe 7xa5i41at12jl11t9l", "language" "200", "customlabel" "", "code" "{\n \\"name\\" \\"cake's name\\",\n }" }, { "id" "dbqsb 6mmkatc7dkkrd1d", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ], "selectedlanguageid" "oe 7xa5i41at12jl11t9l" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "optional", "type" "string", "description" "api key del operador", "children" \[] }, { "name" "x access token", "kind" "optional", "type" "string", "description" "access token del operador", "children" \[] } ], "bodydataparameters" \[ { "name" "name", "kind" "required", "type" "string", "description" "nombre y apellido del usuario" }, { "name" "email", "kind" "required", "type" "string", "description" "email del usuario no se podrá crear más de un usuario con el mismo email", "children" \[] }, { "name" "phone", "kind" "required", "type" "string", "description" "teléfono del usuario", "children" \[] }, { "name" "identification", "kind" "required", "type" "string", "description" "número de identificación legal del usuario para argentina enviar cuil \nno se podrá crear más de un usuario con el mismo valor de este campo ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "modificación de usuario", "method" "put", "url" "https //{suga id} sugaway io/p/operator/user/{uid}", "description" "este endpoint permite modificar un usuario previamente dado de alta en el operador", "tab" "examples", "examples" { "languages" \[ { "id" " ulgt9ud9fykhxfkdbxki", "language" "curl", "code" "curl location globoff request put 'https //{suga id} sugaway io/p/operator/user/{uid}/{uid}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\\"name\\" \\"string\\",\\"email\\" \\"string\\",\\"phone\\" \\"string\\"}'", "customlabel" "" }, { "id" "thhvi6cassvm0 lmjdehu", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //{suga id} sugaway io/p/operator/user/{uid}/{uid}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "u10o2vsjig2gn4ttqef9v", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //{suga id} sugaway io/p/operator/user/{uid}/{uid}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "103rhuminlgz18xa j5mu", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //{suga id} sugaway io/p/operator/user/{uid}/{uid}\\"\n\npayload = json dumps({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "uj4sjcchj1p5mluk j2aw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //{suga id} sugaway io/p/operator/user/{uid}/{uid}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"name\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" " ulgt9ud9fykhxfkdbxki" }, "results" { "selectedlanguageid" "oe 7xa5i41at12jl11t9l", "languages" \[ { "id" "oe 7xa5i41at12jl11t9l", "language" "200", "customlabel" "", "code" "{\n \\"name\\" \\"cake's name\\",\n }" }, { "id" "dbqsb 6mmkatc7dkkrd1d", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ] }, "request" { "pathparameters" \[ { "name" "uid", "kind" "required", "type" "string", "description" "id del usuario a editar", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "api key del operador", "children" \[] }, { "name" "x access token", "kind" "required", "type" "string", "description" "access token del operador", "children" \[] } ], "bodydataparameters" \[ { "name" "name", "kind" "optional", "type" "string", "description" "nombre y apellido del usuario enviar en caso de querer modificar" }, { "name" "email", "kind" "optional", "type" "string", "description" "email del usuario enviar en caso de querer modificar el email actual ", "children" \[] }, { "name" "phone", "kind" "optional", "type" "string", "description" "teléfono del usuario enviar en caso de querer modificar ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } los posibles códigos de error al crear o modificar un usuario son user\ missing data user\ user exist no valid ndfe > el {uid} de usuario no corresponde a un usuario válido { "name" "desactivar usuario", "method" "put", "url" "https //{suga id} sugaway io/p/operator/user/{uid}/action/inactive", "description" "este endpoint permite desactivar un usuario", "tab" "examples", "examples" { "languages" \[ { "id" "uj4sjcchj1p5mluk j2aw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //{suga id} sugaway io/p/operator/user/{uid}/action/inactive\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "uj4sjcchj1p5mluk j2aw" }, "results" { "languages" \[ { "id" "oe 7xa5i41at12jl11t9l", "language" "200", "customlabel" "", "code" "{\n \\"result\\" true,\n \\"data\\" {}\n}" }, { "id" "dbqsb 6mmkatc7dkkrd1d", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ], "selectedlanguageid" "dbqsb 6mmkatc7dkkrd1d" }, "request" { "pathparameters" \[ { "name" "uid", "kind" "required", "type" "string", "description" "id del usuario a inactivar", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "api key del operador", "children" \[] }, { "name" "x access token", "kind" "required", "type" "string", "description" "access token del operador", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "reactivar usuario", "method" "put", "url" "https //{suga id} sugaway io/p/operator/user/{uid}/action/active", "description" "este endpoint permite reactivar un usuario previamente inhabilitado", "tab" "examples", "examples" { "languages" \[ { "id" "uj4sjcchj1p5mluk j2aw", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //{suga id} sugaway io/p/operator/user/{uid}/action/active\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "uj4sjcchj1p5mluk j2aw" }, "results" { "languages" \[ { "id" "oe 7xa5i41at12jl11t9l", "language" "200", "customlabel" "", "code" "{\n \\"result\\" true,\n \\"data\\" {}\n}" }, { "id" "dbqsb 6mmkatc7dkkrd1d", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ], "selectedlanguageid" "oe 7xa5i41at12jl11t9l" }, "request" { "pathparameters" \[ { "name" "uid", "kind" "required", "type" "string", "description" "id del usuario a re activar", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "api key del operador", "children" \[] }, { "name" "x access token", "kind" "required", "type" "string", "description" "access token del operador", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "asignar usuario a entidad", "method" "post", "url" "https //{suga id} sugaway io/p/entity/users/{action}", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "jeuoqm584wpudbys9qkfj", "language" "curl", "code" "curl location globoff 'https //{suga id} sugaway io/p/entity/users/{action}/{action}' \\\\\n header 'x api key string' \\\\\n header 'x access token string' \\\\\n header 'x suga entity string' \\\\\n data '{\\"role\\" \\"string\\",\\"email\\" \\"string\\"}'", "customlabel" "" }, { "id" "w kb4d1auvtohl6jg2ir1", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //{suga id} sugaway io/p/entity/users/{action}/{action}',\n 'headers' {\n 'x api key' 'string',\n 'x access token' 'string',\n 'x suga entity' 'string'\n },\n body '{\\"role\\" \\"string\\",\\"email\\" \\"string\\"}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "0p6se zirz rixm6ns d", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x api key\\", \\"string\\");\nmyheaders append(\\"x access token\\", \\"string\\");\nmyheaders append(\\"x suga entity\\", \\"string\\");\n\nvar raw = \\"{\\\\\\"role\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\"}\\";\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //{suga id} sugaway io/p/entity/users/{action}/{action}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "rvhk0n9j2lekl4lger8so", "language" "python", "code" "import requests\n\nurl = \\"https //{suga id} sugaway io/p/entity/users/{action}/{action}\\"\n\npayload = \\"{\\\\\\"role\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\"}\\"\nheaders = {\n 'x api key' 'string',\n 'x access token' 'string',\n 'x suga entity' 'string'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "bs3znda044 lkthbmvxpm", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //{suga id} sugaway io/p/entity/users/{action}/{action}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"x api key\\"] = \\"string\\"\nrequest\[\\"x access token\\"] = \\"string\\"\nrequest\[\\"x suga entity\\"] = \\"string\\"\nrequest body = \\"{\\\\\\"role\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\"}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "jeuoqm584wpudbys9qkfj" }, "results" { "languages" \[ { "id" "zpj2udfczoplqenyv3uui", "language" "200", "customlabel" "", "code" "{\n \\"name\\" \\"cake's name\\",\n}" }, { "id" "vth3wwn38cs1raoq3ilwa", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}" } ], "selectedlanguageid" "zpj2udfczoplqenyv3uui" }, "request" { "pathparameters" \[ { "name" "action", "kind" "required", "type" "string", "description" "acción a realizar sobre el usuario y la entidad valores disponibles add, remove", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "api key del operador ", "children" \[] }, { "name" "x access token", "kind" "required", "type" "string", "description" "token de acceso del operador ", "children" \[] }, { "name" "x suga entity", "kind" "required", "type" "string", "description" "id de la entidad sobre la cual se desea realizar la operación ", "children" \[] } ], "bodydataparameters" \[ { "name" "role", "kind" "optional", "type" "string", "description" "rol a asignar al usuario solo enviar en caso de alta (add) valores disponibles admin" }, { "name" "email", "kind" "required", "type" "string", "description" "email del usuario sobre el que se desea ejecutar la acción", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }