tForms
Integração e API
Transaction
2 min
{ "name" "create new transaction", "method" "post", "url" "https //api tsrtech com br", "description" "permite a criação de uma transação/experiência via api", "tab" "examples", "examples" { "languages" \[ { "id" "na95e9k5lciscmqi1uftf", "language" "curl", "code" "curl location 'https //api tsrtech com br' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"type\\" \\"string\\",\n \\"token\\" \\"string\\",\n \\"survey id\\" \\"number\\",\n \\"client name\\" \\"string\\",\n \\"cpf\\" \\"string\\",\n \\"email\\" \\"string\\",\n \\"phone\\" \\"string\\",\n \\"gender\\" \\"string\\",\n \\"store\\" \\"string\\",\n \\"amount\\" \\"string\\",\n \\"external id\\" \\"string\\",\n \\"extras\\" \\"string\\",\n \\"channel\\" \\"number\\"", "customlabel" "curl" } ], "selectedlanguageid" "na95e9k5lciscmqi1uftf" }, "results" { "languages" \[ { "id" "tfgk d629lorqw9lut 67", "language" "200", "customlabel" "", "code" "{\n \\"created\\" true,\n \\"status\\" 0,\n \\"transaction id\\" 9999,\n \\"client id\\" \\"9999\\"\n}" }, { "id" "fpchhzru9bfyvowotcdoa", "language" "406", "customlabel" "", "code" "{\n \\"created\\" false,\n \\"status\\" 2,\n \\"detail\\" \\"invalid survey id\\"\n}" } ], "selectedlanguageid" "tfgk d629lorqw9lut 67" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "type", "kind" "required", "type" "string", "description" "transaction", "children" \[] }, { "name" "token", "kind" "required", "type" "string", "description" "token de acesso", "children" \[] }, { "name" "survey id", "kind" "required", "type" "number", "description" "id da pesquisa", "children" \[] }, { "name" "client name", "kind" "required", "type" "string", "description" "nome do respondente", "children" \[] }, { "name" "cpf", "kind" "optional", "type" "string", "description" "cpf / cnpj", "children" \[] }, { "name" "email", "kind" "optional", "type" "string", "description" "email do respondente", "children" \[] }, { "name" "phone", "kind" "optional", "type" "string", "description" "telefone do respondente", "children" \[] }, { "name" "gender", "kind" "optional", "type" "string", "description" "gênero do respondente", "children" \[] }, { "name" "store", "kind" "optional", "type" "string", "description" "id da loja", "children" \[] }, { "name" "amount", "kind" "optional", "type" "string", "description" "valor da experiência", "children" \[] }, { "name" "external id", "kind" "optional", "type" "string", "description" "identificador único externo", "children" \[] }, { "name" "extras", "kind" "optional", "type" "string", "description" "parâmetros extras (formato json)", "children" \[] }, { "name" "channel", "kind" "required", "type" "string", "description" "canal de envio da pesquisa (1 whatsapp, 2 sms, 3 email)", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "get all transactions", "method" "get", "url" "https //api tsrtech com br", "description" "exibe todas as transações/experiências enviadas para a tsr bem como o status de cada uma ", "tab" "examples", "examples" { "languages" \[ { "id" "45ov8dgb6x40viloyjp m", "language" "curl", "code" "curl location request get 'https //api tsrtech com br' \\\\\n header 'accept application/json' \\\\\n data raw \n'{\n \\"type\\" \\"transactions all,\n \\"token\\" \\"string\\"\n \\"survey id\\" number\n}'", "customlabel" "" } ], "selectedlanguageid" "45ov8dgb6x40viloyjp m" }, "results" { "languages" \[ { "id" "fnlx6tqcmu4cv6q1wrqdn", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"2194\\",\n \\"external id\\" \\"9293\\",\n \\"created at\\" \\"2023 07 29 02 39 34\\",\n \\"author\\" \\"40\\",\n \\"survey\\" \\"72\\",\n \\"client\\" \\"926\\",\n \\"store\\" \\"loja 01\\",\n \\"amount\\" \\"1\\",\n \\"extras\\" \\"9293\\",\n \\"channel\\" \\"3\\",\n \\"cicle\\" \\"0\\",\n \\"dispatch\\" \\"1\\",\n \\"dispatch at\\" \\"2023 07 29 02 40 02\\",\n \\"response\\" \\"canal não permitido\\",\n \\"status\\" \\"2\\"\n }" }, { "id" " yhatjl0y6cwgmpw04sfo", "language" "406", "customlabel" "", "code" "{\n \\"message\\" \\"no content\\"\n }" } ], "selectedlanguageid" "fnlx6tqcmu4cv6q1wrqdn" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "token", "kind" "required", "type" "string", "description" "token de acesso" }, { "name" "type", "kind" "required", "type" "string", "description" "transactions all", "children" \[] }, { "name" "survey id", "kind" "required", "type" "number", "description" "id da pesquisa", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "get specific transaction", "method" "get", "url" "https //api tsrtech com br", "description" "exibe uma transação em específico, com detalhes de resposta caso houver ", "tab" "examples", "examples" { "languages" \[ { "id" "pmxvdfzjgsnnnhiidtle ", "language" "curl", "code" "curl location request get 'https //api tsrtech com br' \\\\\n header 'accept application/json' \\\\\n data raw '{\n \\"type\\" \\"transaction\\",\n \\"token\\" \\"string\\",\n \\"transaction id\\" number\n}'", "customlabel" "" } ], "selectedlanguageid" "pmxvdfzjgsnnnhiidtle " }, "results" { "languages" \[ { "id" "n2mtkpddiz0s6koxjjpw0", "language" "200", "customlabel" "", "code" " {\n \\"external id\\" \\"\\",\n \\"transaction id\\" \\"xxxxxx\\",\n \\"survey id\\" \\"xx\\",\n \\"response status\\" \\"not answered\\",\n \\"survey title\\" \\"pesquisa xxxxx\\",\n \\"client name\\" \\"xxxxx\\",\n \\"cpf\\" \\"\\",\n \\"email\\" \\"xx\@xx com\\",\n \\"phone\\" \\"\\",\n \\"gender\\" \\"\\",\n \\"store\\" \\"\\",\n \\"amount\\" \\"\\",\n \\"cicle\\" \\"d+7\\",\n \\"channel\\" \\"whatsapp\\",\n \\"last status\\" \\"falha\\",\n \\"response date\\" null,\n \\"responses\\" null\n }" }, { "id" "wcursemkkv1bue1wbcub9", "language" "404", "customlabel" "", "code" "{\n \\"error\\" \\"transaction not found\\"\n }" } ], "selectedlanguageid" "wcursemkkv1bue1wbcub9" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "token", "kind" "required", "type" "string", "description" "token de acesso" }, { "name" "type", "kind" "required", "type" "string", "description" "transaction", "children" \[] }, { "name" "indicator", "kind" "optional", "type" "string", "description" "metodologia caso utilize na pesquisa (nps / csat)", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }