Servicio de listado de concesionarios
Detalles de la llamada#
- Recurso:
/v3/rechargedealers - Método HTTP:
GET - Formato de la solicitud:
query string - Formato de la respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
Authorization | Firma de autenticidad en formato Bearer {assinatura}. Más información.Exemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34.Este campo es obligatorio si la transacción fue creada por el proceso de suscripción. | < 2000 AN | COND. |
Ejemplos#
A continuación, se muestran ejemplos de cómo llamar al servicio de listado de concesionarios utilizando la herramienta cURL.
Listado de concesionarios de recarga normal#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Lista de distribuidores de recarga para otros productos (others)#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Listado de concesionarios de pago de facturas de suscripción (invoice)#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Listado de concesionarios con envío de firma#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Parámetros de solicitud#
En la siguiente tabla, hay una descripción de los parámetros de solicitud para el servicio de listado de distribuidores:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
nit | Identificación de transacción de recarga de Portal Carat | = 64 A | SI |
generalhash | Código de identificación de la versión de la tabla con datos relacionados con recargas (operadores, sucursales, rangos de valor, vigencia de crédito, entre otros). Si la tienda no ha realizado previamente una recarga o no la ha realizado Después de guardar un valor de generalhash recibido previamente del Portal Carat, el valor: 0000000000000000 se puede transferir al Portal Carat. Este campo permite al comerciante saber si ha habido un cambio en el recargar datos. Esto se debe a que si hubo algún cambio en la tabla, el generalhash devuelto será diferente del generalhash que tiene el comerciante. En este caso, es recomendable que el propietario de la tienda realice las consultas y actualice los valores de los operadores de recarga en su aplicación. | = 16 A | NO |
Parâmetros de resposta#
Si tiene éxito, el código de respuesta HTTP será 200. Cualquier otro código debe interpretarse como un error. En la siguiente tabla se encuentra la descripción de los parámetros de respuesta del servicio de lista del distribuidor:
| Parámetro | Descripción | Formato |
|---|---|---|
status | Status de la transacción de recarga de Portal Carat. [Más información.] (codigos-da-api.md#status-de-transacões-do-e-sitef) | = 3 AN |
| esitef | ||
code | Código de respuesta de Portal Carat. Cualquier código que no sea 0 (cero) significa falla. [Más información.] (codigos-da-api.md#codigos-de-resposta) | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
| authorizer | ||
code | Código de respuesta devuelto por el autorizador | < 4 AN |
message | Mensaje devuelto por el autorizador | < 64 AN |
| hashes | ||
general | Código de identificación de tabla con datos relacionados con recargas (operadores, sucursales, rangos de valor, validez de crédito, entre otros). | = 16 AN |
| dealers[] | ||
code | Código de distribuidor / operador | = 3 N |
name | Nombre del distribuidor / operador | < 100 AN |
| distribuidores []. sucursales [] | ||
code | Código de afiliado | = 11 N |
name | Nombre del afiliado | < 100 AN |
| dealers[].branches[] | Este campo agrega una lista de preguntas para confirmación positiva. Las preguntas devueltas deben, obligatoriamente, ser respondidas por el usuario y tener sus respuestas enviadas a Portal Carat en el siguiente paso (listando los datos del afiliado). | |
id | Código de identificación de la pregunta | < 20 AN |
display | Texto de la pregunta que se presentará | < 180 AN |
rule | Indica dónde se deben recopilar los datos. [Más información.] (#retorno-do-campo-questionsrule) | < 2 AN |
min | Indica el tamaño mínimo de respuesta | < 4 N |
max | Indica el tamaño máximo de la respuesta | < 5 N |
type | Indica el tipo de datos de respuesta que se recopilarán. [Más información.] (#retorno-do-campo-questionstype) | < 3 AN |
min_value | Indica el valor mínimo de respuesta | < 3 N |
max_value | Indica el valor máximo de la respuesta | < 3 N |
Devolución del campo questions.rule#
| Regla | Descripción |
|---|---|
0 | Teclado de operador |
1 | PinPad (no aplicable) |
2 | Lectura de pista magnética en PIN PAD (no aplicable) |
3 | Automatización (La pregunta no debe presentarse al operador / cliente para recopilar la respuesta. En este caso, la automatización misma debe responder a la pregunta sin la intervención del operador / cliente). |
4 | Contraseña de supervisor (no PINPAD) |
5 | Teclado de operador con doble digitación. El <Display> debe contener dos textos, el primero referido a la solicitud de ingreso de datos y el segundo referido a la confirmación de ingreso de datos, que debe ser igual al primero. Los textos deben estar separados por ; como se informa a continuación. <Display> = Texto de la 1ª recolección; Texto de la 2ª recolección (confirmación) |
6 | Lector de códigos de barras |
7 | Escribiendo con confirmación (En este caso, se debe presentar una pantalla para confirmar los datos recolectados). |
Devolución del campo questions.type#
| Tipo | Descripción |
|---|---|
A | Alfabético. |
AN | Alfanumérico especial (ans). |
LN | Letras (sin acentuar) y números. |
Nx | Numérico donde x es el número de decimales admitidos. |
Vx | Valor con x en los decimales. |
S | Menú tipo Sí / No. |
Sc | Menú condicional Sí / No. Si la entrada es "No", la transacción debe cancelarse. |
M | Menú libre. En este caso, el campo <Display> tendrá el siguiente formato: el texto del menú debe estar separado por un carácter & # 124; de las opciones. Las opciones, a su vez, deben constar de índice y texto separados por :, mientras que una opción está separada por la otra por ^. En otras palabras: <Display> = <Texto Menu>|<opção 1>^<opção 2>^...^<opção N> Onde, <Texto Menu> = Texto del encabezado del menú (Ej .: Elegir marca de la tarjeta) <Opción N> = <Índice>: <Texto de opción> (Ej .: 1 : Visa) |
Mc | Menú gratuito con confirmación. Sigue la regla del menú gratuito, donde: <Display> = <Texto del menú > & # 124; <Texto de confirmación > & # 124; <opción 1 > ^ <opción 2 > ^ ... ^ <opción N > |
M0 | Tipo de menú libre 0 (cero). (No aplicable) Sigue la regla del menú libre con confirmación, sin embargo, los índices de selección del menú en la pantalla deben suprimirse y seleccionarse solo con las flechas POS. Ejemplo de la pantalla del menú libre: 1 - Sí 2 - No Ejemplo de tipo de visualización del menú gratuito 0: Sí No |