NAV Navbar


Ikniu logo
curl

API Enviroment

Producción

https://api.ikniu.mx

Staging

htpp://staging-api.ikniu.mx

Miembros

Obtener todos los miembros

Request
[
  {
    "id": "",
    "firstName": "",
    "clientId": "",
    "firstLastName": "",
    "secondLastName": "",
    "email": "",
    "birthDate": "",
    "subscriptionDate": "",
    "rank": {
      "name": ""
    },
    "balance": 0,
    "expiredAmount": 0,
    "address": [
      {
        "street": "",
        "numberInside": "",
        "numberOutside": "",
        "postcode": {
          "country": {
            "name": ""
          },
          "state": {
            "name": ""
          },
          "city": {
            "name": ""
          }
        }
      }
    ]
  }
]

Campos Requeridos

Atributo
Tipo
Descripción
firstName String Nombre(s) del miembro
firstLastName String Primer apellido
email String Correo electrónico

Campos Opcionales

Atributo
Tipo
Descripción
secondLastName String Segundo apellido
birthdate String Fecha de nacimiento
memberId String Id del miembro

Obtener miembro en especifico

Parámetros para realizar la petición:

Request
{
  "id": "",
  "clientId": "",
  "firstName": "",
  "firstLastName": "",
  "secondLastName": "",
  "email": "",
  "birthDate": "",
  "subscriptionDate": "",
  "rank": {
    "name": ""
  },
  "balance": 0,
  "expiredAmount": 0,
  "address": [
    {
      "street": "",
      "numberInside": "",
      "numberOutside": "",
      "postcode": {
        "country": {
          "name": ""
        },
        "state": {
          "name": ""
        },
        "city": {
          "name": ""
        }
      }
    }
  ]
}

Respuesta entregada.

Parámetros en URL
apiKey Identificador único del comercio.
programId Identificador del programa que se requiere obtener.
memberClientId Identificador del miembro para el programa.
Método GET
URI https://api.ikniu.mx/v1/seller/[apiKey]/program/[programId]/member/[memberClientId]

Crear miembro

Request
{
    "email": "",
    "firstName": "",
    "firstLastName": "",
    "rank": "",
    "clientId": "",
    "subscriptionDate": "",
    "country": ""
}

Para crear un miembro es necesario generar una peticion con los siguientes datos:

POST /v1/seller/:apiKey/program/:programClientId/member

Parámetros
Email Email del miembro
FirstName Primer Nombre del miembro
firstLastName Primer Apellido del miembro
rank Rango
clientId Cliente ID
subscriptionDate Fecha de Registro
country Estado

Programas

Tipo de respuesta entregada:
[
  {
    "seller": "",
    "user": "",
    "rangeGroup": "",
    "currency": {
      "iso": "",
      "name": "",
      "change": 0,
      "status": true
    },
    "unit": {
      "name": "",
      "base": true,
      "status": true
    },
    "redemptionBase": {
      "value": 0,
      "balance": ""
    },
    "accumulationBase": {
      "balance": "",
      "value": 0
    },
    "durationPointsUnitTime": {
      "name": "",
      "unitType": "",
      "value": 0
    },
    "name": "",
    "clientId": "",
    "status": "",
    "createdAt": "",
    "updatedAt": "",
    "id": ""
  }
]

Parámetros para realizar la petición:

Parámetros en URL
apiKey Identificador único del comercio.
Método GET
URI https://api.ikniu.mx/v1/seller/[apiKey]/program

Parámetros para realizar la petición:

[GET] /v1/seller/:apiKey/program/:programId

Parámetros en URL
apiKey Identificador único del comercio.
programId Identificador del programa que se requiere obtener.
Método GET
URI https://api.ikniu.mx/v1/seller/[apiKey]/program/[programId]

Obtener balance del cliente

El siguiente servicio entrega el balance del Cliente

[GET] v1/seller/:apiKey/program/:programId/member/:memberId/balance

Atributo Tipo Descripción
apiKey string Llave publica del seller
programId string Identificador del programa
memberId string Identificador del cliente

Abono de puntos

Parametros
[
    {
        "programId": [type: string, required: true],
        "memberId": [type: string, required: (Solo si 'member' no es proporcionado)],
        "amount": [type: numeric, required: true],
        "branchId": [type: string],
        "vendorId": [type: string],
        "items": [type: array,
        value: {"sku":"", "name":"", "quantity":1, "unitPrice":1}],
        "comments": [type: string, required: true],
        "concept": [type: string],
        "reference": [type: string],
        "currency": [type: string],
        "member": [type: object, required:(Solo si memberId no es proporcionado)attributes:"firstName","firstLastName","email"...]
    }
Resultado
[
    {

        "transactionid":"",
        "status": "success, error",
        "description": "",
        "programId": "",
        "memberId": "",
        "totalPoints":
    }
]

Directo

[ Method: POST ] - [API.ENVIROMENT]/v1/seller/:apiKey/deposit

POST] /v1/seller/:apiKey/deposit

Parámetros para realizar la petición:

Parámetros en URL
apiKey Identificador único del comercio.
Método GET
URI https://api.ikniu.mx/v1/seller/[apiKey]/deposit

Ejemplo

Estos son los datos mínimos requeridos para generar la redención

Datos mínimos
    [
        {
        "programId": "1510730993239",
        "memberId": "CM1521587084121",
        "amount": "1000",
        "comments": "Prueba",
        "concept": "Prueba",
        "reference": "1232132",
        "currency": "MXN"
        }
    ]

Redención de puntos

Parametros:

[
    {
        "programId": [type: string, required: true],
        "memberId": [type: string, required: true],
        "amount": [type: numeric, required: true],
        "items": [type: array,
        value: {"sku":"", "name":"", "quantity":1, "unitPrice":1}],
        "branchId": [type: string],
        "vendorId": [type: string],
        "reference": [type: string],
        "comments": [type: string, required: true],
        "member": [type: object,
        attributes: "firstName", "firstLastName", "email"...],
        "amountCurrency": [type: numeric, required: true]
    }
]

Resultado:

[
    {
        "transactionId": "",
        "status": "success, error",
        "description": "",
        "programId": "",
        "memberId": "",
        "totalPoints": 0
    }
]

Directo

[ Method: POST ] https://[API.ENVIROMENT]/v1/seller/:apiKey/redemption

Parámetros para realizar la petición:

Atributo
Tipo
Descripción
programId String ID Programa
memberId String Id del miembro al que se van abonar puntos
amount Numeric Monto en puntos que dse van a redimir
item String Objeto
branchId String ID Rama
vendorId String ID Vendedor
reference String Referencia de la redención
comments String Comentarios
member String Miembro
amountCurrency Numeric PreMonto en pesos, equivalente a los puntos totales que se quieren redimir (Base de redención)cio

Acumulación

Requisitos necesarios para realizar una acumulacion de puntos:

Parametro
Tipo
Descripción
programId String ID Programa
amount Numeric Monto en pesos que se van abonar
comments String Comentarios del abono
reference String Referencia del abono
member String Id del miembro al que se van abonar puntos

Ejemplo

Estos son los datos mínimos requeridos para generar la redención

Datos mínimos
[
    {
        "programId": "10730993221",
        "memberId": "CM157084120011",
        "amount": "1000",
        "reference": "1234567890",
        "comments": "Puntos de prueba",
        "amountCurrency": "MXN"
    }
]