InputRequest<\/code>:<\/p>\n\n- Confirma\u00e7\u00e3o<\/a> - Mostre algumas informa\u00e7\u00f5es e pe\u00e7a ao cliente para confirmar se concorda.<\/li>\n
- Assinatura<\/a> - Mostre algumas informa\u00e7\u00f5es e pe\u00e7a ao cliente que confirme fornecendo sua assinatura.<\/li>\n
- Menu<\/a> - Mostre uma pergunta de m\u00faltipla escolha e deixe o usu\u00e1rio selecionar uma das respostas. Voc\u00ea pode usar isso para pesquisas do NPS, listas de pedidos e outros.<\/li>\n
- Num\u00e9rico<\/a> - Voc\u00ea normalmente usa isso para pedir ao cliente o n\u00famero de telefone. Outro exemplo \u00e9 um fluxo de pagamento na mesa em que voc\u00ea solicita \u00e0 sua equipe o n\u00famero da mesa.<\/li>\n
- Texto<\/a> - Voc\u00ea normalmente usa isso para pedir ao cliente o endere\u00e7o de e-mail.<\/li>\n<\/ul>\n
Para cada tipo de entrada, fornecemos elementos predefinidos para exibi\u00e7\u00e3o no visor do terminal e campos que voc\u00ea precisa preencher com seu pr\u00f3prio texto. O usu\u00e1rio digita uma resposta na tela ou nos bot\u00f5es do teclado do terminal<\/p>\n
\nVoc\u00ea n\u00e3o pode solicitar informa\u00e7\u00f5es de clientes em terminais que n\u00e3o oferecem suporte \u00e0 API de Terminais ou em terminais que suportam apenas um subconjunto da API de Terminais.<\/p>\n<\/div><\/div>\n
Coletar informa\u00e7\u00f5es do usu\u00e1rio<\/h2>\n
Esse \u00e9 o procedimento geral para fazer uma pergunta ao cliente ou sua equipe e coletar a resposta. Consulte os tipos de entrada para detalhes espec\u00edficos.<\/p>\n
\n- \n
Fa\u00e7a uma solicita\u00e7\u00e3o POST para um endpoint da API de terminais<\/a>, especificando:<\/p>\n\n- \n
Objeto MessageHeader<\/code>: Segue a estrutra da MessageHeader<\/code> padr\u00e3o, explicada nos fundamentos da API de terminais<\/a>:<\/p>\n\nProtocolVersion<\/code>: 3.0<\/strong><\/li>\nMessageClass<\/code>: Device<\/strong><\/li>\nMessageCategory<\/code>: Input<\/strong><\/li>\nMessageType<\/code>: Request<\/strong><\/li>\nSaleID<\/code>: Seu ID exclusivo para a caixa registradora.<\/li>\nServiceID<\/code>: Seu ID exclusivo para a tentativa de transa\u00e7\u00e3o, consistindo em 1 a 10 caracteres alfanum\u00e9ricos. Esse valor precisa ser exclusivo nas \u00faltimas 48 horas.<\/li>\n- \n
POIID<\/code>: ID exclusivo do terminal. Isso indica para qual terminal o pagamento ser\u00e1 roteado.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
InputRequest.DisplayOutput<\/code>: Esta parte do corpo da solicita\u00e7\u00e3o define o que \u00e9 mostrado no terminal:<\/p>\n\n- \n
Device<\/code>: CustomerDisplay<\/strong><\/p>\n<\/li>\n- \n
InfoQualify<\/code>: Display<\/strong><\/p>\n<\/li>\n- \n
OutputContent.OutputFormat<\/code>: Text<\/strong>.<\/p>\n<\/li>\n- \n
OutputContent.PredefinedContent.ReferenceID<\/code>: TO conjunto de elementos predefinidos que voc\u00ea deseja usar:<\/p>\n\n- GetConfirmation<\/a>: elementos predefinidos para solicitar confirma\u00e7\u00e3o.<\/li>\n
- GetSignature<\/a>: elementos predefinidos para solicitar uma assinatura.<\/li>\n
- MenuButtons<\/a>: elementos predefinidos para permitir que o usu\u00e1rio selecione uma resposta.<\/li>\n
- GetDigit<\/a>: elementos predefinidos para solicitar uma informa\u00e7\u00e3o num\u00e9rica.<\/li>\n
- \n
GetText<\/a>: elementos predefinidos para solicitar uma informa\u00e7\u00e3o de texto.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
OutputContent.OutputText<\/code>: Uma matriz de um ou mais campos Text<\/code> contendo seu pr\u00f3prio texto para mostrar no terminal. Consulte os tipos de entrada abaixo para aprender como usar esses campos.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
InputRequest.InputData<\/code>: Esta parte do corpo da solicita\u00e7\u00e3o lida com a informa\u00e7\u00e3o do usu\u00e1rio:<\/p>\n\n- \n
Device<\/code>: CustomerInput<\/strong>.<\/p>\n<\/li>\n- \n
InfoQualify<\/code>: Input<\/strong>.<\/p>\n<\/li>\n- \n
InputCommand<\/code>: Comando para lidar com o tipo de informa\u00e7\u00e3o do usu\u00e1rio:<\/p>\n\n- GetConfirmation<\/a>: solicite confirma\u00e7\u00e3o ou assinatura.<\/li>\n
- GetMenuEntry<\/a>: pe\u00e7a para selecionar uma resposta para uma pergunta de m\u00faltipla escolha.<\/li>\n
- DigitString<\/a>: solicita informa\u00e7\u00e3o num\u00e9rica.<\/li>\n
- \n
TextString<\/a>: solicita informa\u00e7\u00e3o de texto.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
MaxInputTime<\/code>: Tempo limite em segundos. Este \u00e9 o tempo que o usu\u00e1rio obt\u00e9m para concluir sua resposta.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\nO exemplo a seguir mostra os campos comuns para todos os tipos de informa\u00e7\u00e3o.<\/p>\n
\n<\/code-sample>\n<\/div>\n\nAlguns tipos de informa\u00e7\u00f5es requerem campos adicionais ou valores espec\u00edficos. Consulte os tipos de entrada abaixo.<\/p>\n<\/div><\/div>\n<\/li>\n
- \n
Aguarde o usu\u00e1rio fornecer a informa\u00e7\u00e3o solicitada usando os bot\u00f5es na tela ou o teclado do terminal.<\/p>\n
\nA informa\u00e7\u00e3o fornecida pelo cliente ou sua equipe n\u00e3o \u00e9 validada em um formato.<\/p>\n<\/div><\/div>\n
Na resposta, o InputResult<\/code> mostra se o usu\u00e1rio concordou ou discordou, forneceu uma assinatura, selecionou uma resposta para a pergunta de m\u00faltipla escolha, inseriu n\u00fameros ou texto ou recusou-se a fornecer informa\u00e7\u00f5es.
\nSe o pedido expirar, a resposta conter\u00e1 um \n EventNotification<\/code>\n<\/a> com os EventDetails<\/code>: message=Did+not+receive+a+response+from+the+POI.<\/strong><\/p>\n<\/li>\n- \n
Passe os dados relevantes do InputResult<\/code> para o seu sistema para valida\u00e7\u00e3o e uso posterior.<\/p>\n<\/li>\n<\/ol>\nConfirma\u00e7\u00e3o<\/h2>\n
Em um InputRequest<\/code> solicitando que o cliente confirme alguma informa\u00e7\u00e3o, \u00e9 necess\u00e1rio especificar os campos comuns para coletar as informa\u00e7\u00f5es do usu\u00e1rio<\/a>, bem como os seguintes valores e campos espec\u00edficos:<\/p>\n\n- \n
DisplayOutput.OutputContent.PredefinedContent.ReferenceID<\/code>: GetConfirmation<\/strong>.<\/p>\n<\/li>\n- \n
DisplayOutput.OutputContent.OutputText<\/code>: Uma matriz de quatro campos Text<\/code> contendo seu pr\u00f3prio texto para mostrar no terminal.<\/p>\n\n- O primeiro campo
Text<\/code> \u00e9 o t\u00edtulo.<\/li>\n- O segundo campo
Text<\/code> representa um texto adicional que pode ser longo e \u00e9 rol\u00e1vel.<\/li>\n- O terceiro campo
Text<\/code> \u00e9 o t\u00edtulo do bot\u00e3o 'decline' \u00e0 esquerda.<\/li>\n- \n
O quarto campo Text<\/code> \u00e9 o t\u00edtulo do bot\u00e3o 'agree' \u00e0 direita.<\/p>\n\n<\/li>\n<\/ol>\n<\/li>\n- \n
InputData.InputCommand<\/code>: GetConfirmation<\/strong><\/p>\n<\/li>\n<\/ul>\nO exemplo a seguir pede ao cliente para confirmar que concorda.<\/p>\n
\n <\/code-sample>\n<\/div>\n\nPara obter uma lista completa dos campos que voc\u00ea pode passar em uma solicita\u00e7\u00e3o de informa\u00e7\u00e3o de confirma\u00e7\u00e3o, consulte a InputRequest<\/a>.<\/p>\n<\/div><\/div>\nNa resposta, ConfirmedFlag<\/code>: true<\/strong> indica que o cliente tocou no bot\u00e3o 'agree' \u00e0 direita ou pressionou ![\"\"](\"\/images\/e\/1\/f\/d\/f\/e1fdf2ab953d26666e876b743ce54acaa22e7206-confirm2x.png\")
<\/strong> para confirmar o seu acordo. ConfirmedFlag<\/code>: false<\/strong> significa que o cliente tocou no bot\u00e3o 'decline' \u00e0 esquerda ou pressionou ![\"\"](\"\/images\/6\/2\/0\/e\/0\/620e0c5c343676dd2b947bbdb1573f7eebc3caf7-cancel2x.png\")
<\/strong>.<\/p>\n\n <\/code-sample>\n<\/div>\n\nPara obter uma lista completa dos campos que voc\u00ea pode receber em uma resposta de informa\u00e7\u00e3o de confirma\u00e7\u00e3o, consulte a InputResponse<\/a>.<\/p>\n<\/div><\/div>\nAssinatura<\/h2>\n
Em um InputRequest<\/code> solicitando que o cliente assine algo e confirme, \u00e9 necess\u00e1rio especificar os campos comuns para coletar a informa\u00e7\u00e3o do cliente<\/a> bem como os seguintes valores e campos espec\u00edficos:<\/p>\n\n- \n
DisplayOutput.OutputContent.PredefinedContent.ReferenceID<\/code>: GetSignature<\/strong>. Al\u00e9m do texto que voc\u00ea especificar, o terminal mostrar\u00e1 uma caixa de entrada para o cliente desenhar sua assinatura.<\/p>\n<\/li>\n- \n
DisplayOutput.OutputContent.OutputText<\/code>: An array of four Text<\/code> fields containing your own text to show on the terminal.<\/p>\n\n- O primeiro campo
Text<\/code> \u00e9 o t\u00edtulo.<\/li>\n- O segundo campo
Text<\/code> cont\u00e9m informa\u00e7\u00f5es adicionais.<\/li>\n- O terceiro campo
Text<\/code> \u00e9 o t\u00edtulo do bot\u00e3o 'decline' \u00e0 esquerda.<\/li>\n- \n
O quarto campo Text<\/code> \u00e9 o t\u00edtulo do bot\u00e3o 'agree' \u00e0 direita.<\/p>\n\n<\/li>\n<\/ol>\n<\/li>\n- \n
InputData.InputCommand<\/code>: GetConfirmation<\/strong><\/p>\n<\/li>\n<\/ul>\nO exemplo a seguir solicita a assinatura do cliente.<\/p>\n
\n <\/code-sample>\n<\/div>\n\nPara obter uma lista completa dos campos que voc\u00ea pode transmitir em uma solicita\u00e7\u00e3o de entrada de assinatura, consulte a InputRequest<\/a>.<\/p>\n<\/div><\/div>\nNa resposta, o AdditionalResponse<\/code> cont\u00e9m a assinatura fornecida pelo cliente. ConfirmedFlag<\/code>: true<\/strong> indica que o cliente tocou no bot\u00e3o 'agree' \u00e0 direita ou pressionou <\/strong> para confirmar o acordo. ConfirmedFlag<\/code>: false<\/strong> significa que o cliente tocou no bot\u00e3o 'decline' \u00e0 esquerda ou pressionou <\/strong>.<\/p>\n\n <\/code-sample>\n<\/div>\n\nPara obter uma lista completa dos campos que voc\u00ea pode receber em uma resposta de entrada de assinatura, consulte a InputResponse<\/a>.<\/p>\n<\/div><\/div>\nSele\u00e7\u00e3o de menu<\/h2>\n
Em um InputRequest<\/code> solicitando ao cliente que responda a uma pergunta de m\u00faltipla escolha, \u00e9 necess\u00e1rio especificar os campos comuns para coletar informa\u00e7\u00f5es do cliente<\/a> bem como os seguintes valores e campos espec\u00edficos:<\/p>\n\n- \n
DisplayOutput.OutputContent.PredefinedContent.ReferenceID<\/code>: MenuButtons<\/strong>. O terminal mostra as respostas para escolher como uma lista rol\u00e1vel de caixas que o usu\u00e1rio pode tocar para selecionar.<\/p>\n<\/li>\n- \n
DisplayOutput.OutputContent.OutputText<\/code>: Uma matriz de apenas um campo Text<\/code> contendo seu pr\u00f3prio texto para mostrar no terminal. Use isso para especificar a pergunta.<\/p>\n<\/li>\n- \n
MenuEntry<\/code>: Uma matriz de at\u00e9 15 itens representando as respostas para voc\u00ea escolher. Cada resposta tem:<\/p>\n\nOutputFormat<\/code>: Text<\/strong><\/li>\n- \n
OutputText<\/code>: uma matriz de tr\u00eas campos Text<\/code> com seu pr\u00f3prio texto que juntos formam a resposta.
\nO primeiro campo Text<\/code> ser\u00e1 exibido em negrito. Use uma sequ\u00eancia vazia para os campos Text<\/code> n\u00e3o utilizados.
\nPor exemplo, voc\u00ea pode escrever uma resposta abreviada no primeiro campo, a resposta longa no segundo campo e n\u00e3o usar o terceiro campo. Ou voc\u00ea pode usar os tr\u00eas campos para o nome, descri\u00e7\u00e3o e r\u00f3tulo do artigo.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
InputData.InputCommand<\/code>: GetMenuEntry<\/strong><\/p>\n<\/li>\n<\/ul>\nO exemplo a seguir solicita que o cliente responda a uma pergunta da pesquisa.<\/p>\n
\n <\/code-sample>\n<\/div>\n\nPara obter uma lista completa dos campos que voc\u00ea pode passar em uma solicita\u00e7\u00e3o de informa\u00e7\u00e3o pelo menu, consulte a InputRequest<\/a>.<\/p>\n<\/div><\/div>\nNa resposta, a matriz MenuEntryNumber<\/code> indica a resposta que o usu\u00e1rio selecionou. Por exemplo, se a terceira resposta foi selecionada, o terceiro item na matriz \u00e9 1<\/code> e todos os outros itens da matriz s\u00e3o 0<\/code>.