Introducción

    Production API Endpoint

        https://portal.bowgift.co/

    Test API Endpoint

        https://test.bowgift.co/
                

Esta API proporciona acceso a los métodos principales para la integración de herramientas de los comercios aliados con BowGift.

Para usar esta API, se necesita un API key y un Merchant Id. Si usted ya es un comercio aliado BowGift, por favor solicite las suyas en soporte@bowgift.co.

Consultar Bono

# Ejemplo de Petición
curl \
-X POST https://portal.bowgift.co/api/gift/validate \
-F 'secret_key=api_key' \
-F 'merchant_id=merchant_id' \
-F 'code=A074O2' 
                

Para consultar el detalle de un bono, realice una petición POST al siguiente método:
https://portal.bowgift.co/api/gift/validate
Una vez la consulta sea exitosa, el API enviará el SMS de redención al teléfono registrado del titular

Ejemplo de Respuesta Errónea:

{
    "error": true,
    "message": "El código ingresado es inválido."
}

Ejemplo de Respuesta Exitosa:

{
  error:false,
  message:"Bono consultado exitosamente.",
  result:{
    "owner_phone":"3133367605"
  }
}
                

PARÁMETROS PETICIÓN

Campo	Tipo	Descripción
secret_key	String	El API key del comercio.
merchant_id	String	El ID del comercio aliado
code	String	El código del bono de regalo

PARÁMETROS RESPUESTA

Campo	Tipo	Descripción
error	Boolean	Indica si se preeseentó un error en la petición
message	String	Mensaje descriptivo de la respuesta a la petición
owner_phone	String	El celular del titular del bono de regalo

Validar código SMS

# Ejemplo de Petición
curl \
-X POST https://portal.bowgift.co/api/gift/smsconfirm \
-F 'secret_key=api_key' \
-F 'merchant_id=merchant_id' \
-F 'code=A074O2' \
-F 'sms=505050'
                

Para validar el código de SMS para la redención de un bono, realice una petición POST al siguiente método:
https://portal.bowgift.co/api/gift/smsconfirm

Ejemplo de Respuesta Errónea:

{
    "error": true,
    "message": "El código ingresado es inválido."
}

Ejemplo de Respuesta Exitosa:

{
    "error": false,
    "info": {
        "redemption_auth":"AT053PD2",
        "gift_code": "A0P43W",
        "value": "250000",
        "bill": "2098342",
        "expiration_date": "2021-09-29",
        "owner_names": "Andres Castillo",
        "owner_email": "andresfcastilloa@gmail.com",
        "owner_phone": "3133367605",
    }
}
                

PARÁMETROS PETICIÓN

Campo	Tipo	Descripción
secret_key	String	El API key del comercio.
merchant_id	String	El ID del comercio aliado
code	String	El código del bono de regalo
sms	String	El código recibido vía SMS en el teléfono del titular

PARÁMETROS RESPUESTA

Campo	Tipo	Descripción
error	Boolean	Indica si se preeseentó un error en la petición
message	String	Mensaje descriptivo de la respuesta a la petición
redemption_auth	String	El código de autorización para redención del bono de regalo
gift_code	String	El código del bono de regalo
value	Int	El saldo disponible del bono de regalo
bill	String	El número de factura correspondiente a la compra del bono de regalo
expiration_date	String	Fecha de vencimiento del bono de regalo
owner_names	String	El nombre completo del titular del bono de regalo
owner_email	String	El correo electrónico del titular del bono de regalo
owner_phone	String	El celular del titular del bono de regalo

Confirmar redención

# Ejemplo de Petición
curl \
-X POST https://portal.bowgift.co/api/gift/redeemed \
-F 'secret_key=api_key' \
-F 'merchant_id=merchant_id' \
-F 'store_id=store_id' \
-F 'redemption_user=redemption_user' \
-F 'redemption_auth=AT053PD2' \
-F 'value=50000'
                

Para redimir un bono, realice una petición POST al siguiente método:
https://portal.bowgift.co/api/gift/redeemed

Ejemplo de Respuesta Errónea:

{
    "error": true,
    "message": "La redención no se pudo completar."
}

Ejemplo de Respuesta Exitosa:

{
  error:false,
  message:"Bono redimido exitosamente.",
  result: {
    merchant_authorization:"BG-P1239ASI9",
    available_balance:0
  }
}
                

PARÁMETROS PETICIÓN

Campo	Tipo	Descripción
secret_key	String	El API key del comercio.
merchant_id	String	El ID del comercio aliado
store_id	String	El ID del punto de venta del comercio donde se redime el bono de regalo
redemption_user	String	El nombre de usuario autorizado para redención del punto de venta del comercio donde se redime el bono de regalo (Caja 1, Caja 2, Caja 3)
redemption_auth	String	El código de autorización de redención recibido cuando se realizó la validación del código SMS
value	Int	El valor de la redención

PARÁMETROS RESPUESTA

Campo	Tipo	Descripción
error	Boolean	Indica si se preeseentó un error en la petición
message	String	Mensaje descriptivo de la respuesta a la petición
merchant_authorization	String	El código de autorización de la redención exitosa del bono de regalo
available_balance	Int	El saldo disponible después de la redención del bono de regalo