API Railway de Suscripción a Marca

Requisitos de la Marca:

  1. La marca deberá estar en proceso contractual con Railway.
  2. Es necesaria la construcción del endPoint bajo la estructura establecida más adelante.
  3. Entregar a Railway la “URL” y “Token” que se deberán utilizar para el envío de códigos Railway.


Funcionamiento:

Para el consumo del API Railway de Suscripción a Marca es necesario lo siguiente:

  • Que el endPoint desarrollado por la Marca, permitirá la comunicación instantánea de los Códigos Railway interesados en promover sus misiones.
  • La Marca deberá agregar y habilitar los Códigos Railway como cupones en su Tienda para poder dar el descuento a los compradores, además deberán quedar identificadas las ventas para que nos puedan proporcionar los resultados al termino de cada semana.
  • NOTA: Los Códigos Railway están compuestos de 12 caracteres alfanuméricos (sin importar si son mayúsculas o minúsculas).

Estructura de comunicación del API:

La Marca deberá habilitar uno de los siguientes métodos del protocolo HTTP para poder recibir los parámetros enviados desde Railway:

  1. Método GET:
    Este método envia las variables “Token” y Código Railway “EJEMPLOCODIGO” dentro de la propia “URL” (dirección) de la página de la Marca.
    Ejemplo: https://URLMarca.com/end-point?token=Token&cupon=EJEMPLOCODIGO


  2. Método POST (con 3 opciones para el envío):
    Este método envia las variables “Token” y Código Railway “EJEMPLOCODIGO” mediante formularios a la “URL” (dirección) de la página de la Marca.

    Opciones:
    • Content-type: application/x-www-form-urlencoded
      token: Token
      cupon: EJEMPLOCODIGO

    • Content-type: application/form-data
      token: Token
      cupon: EJEMPLOCODIGO

    • Content-type: application/json
      {
      "token": "Token",
      "cupon": "EJEMPLOCODIGO"
      }


      El endPoint de la Marca deberá enviar las siguientes respuestas en formato JSON:

      Respuesta de registro correcto:
      {
       "status":"200",
       "error":"false",
       "message":"Cupon was sucsesfully generated and saved.",
       "cupon":"[EJEMPLOCODIGO]"
      }


      Respuesta cuando el Código Railway ya se encontraba registrado:
      {
       "status":"400", 
       "error":"true", 
       "message":"Cupon has allready been generated before." 
      }


      Respuesta de error por falta de parámetros:
      {
       "status":"400",
       "error":"true",
       "message":"Missing data needed for the call: cupon or token array"
      }


      Respuesta de error por uso de Token incorrecto:
      {
       "status":"400",
       "error":"true",
       "message":"Rail Token is incorrect. Please contact admin with the Token used to verify."
      }


      Respuesta de error del endPoint, la Marca puede utilizar los números S101, S102, S103 y S104 para mayor precisión, Railway enviará un correo al responsable de la Marca como notificación:
      {
       "status":"400",
       "error":"true",
       "message":"There was an error checking users Error number [S101, S102, S103, S104]"
      }


    En todas las respuestas, el servidor de la Marca deberá garantizar un HTTP Status Code 200 OK (Success) para que la comunicación sea correcta.



API de Consulta de Existencia de Códigos Railway

Requisitos de la Marca:

  1. La marca deberá estar en proceso contractual con Railway.
  2. Se proporcionará al usuario asignado por la Marca el “Token” para poder realizar el consumo de la API.
  3. Se debe enviar el código Railway “EJEMPLOCODIGO” que se desea verificar.


Funcionamiento:

Para el consumo del API de Consulta de Existencia de Códigos Railway es necesario que:

  • La Marca deberá agregar y habilitar los Códigos Railway como cupones en su Tienda para poder dar el descuento a los compradores, además deberán quedar identificadas las ventas para que nos puedan proporcionar los resultados al término de cada semana.
  • Los Códigos Railway están compuestos de 12 caracteres alfanuméricos (sin importar si son mayúsculas o minúsculas).
  • La marca acceda vía POST a la siguiente URL:

    https://admin.railway.mx/api/show

Estructura de comunicación del API:

curl -X POST \
-H "Content-Type: application/json" \
'http://admin.railway.mx/api/show' \
-d '{"clave":"", "codigo": ""}';

Respuesta correspondiente a un código Railway encontrado:
{
 "error":false,
 "error":false,
}


Respuesta correspondiente a un código Railway no encontrado:
{
 "error":false,
 "message":"Código no encontrado"
}


Respuesta de error por uso de Token incorrecto:
{
 "error":true,
 "message":"Clave not valid"
}


API Asíncrona de Consulta de Códigos Railway

Requisitos de la Marca:

  1. La marca deberá estar en proceso contractual con Railway.
  2. Se proporcionará al usuario asignado por la Marca el “Token” para poder realizar el consumo de la API.


Funcionamiento:

Para el consumo del API Asíncrona de Consulta de Códigos Railway es necesario que:

  • La Marca deberá agregar y habilitar los Códigos Railway como cupones en su Tienda para poder dar el descuento a los compradores, además deberán quedar identificadas las ventas para que nos puedan proporcionar los resultados al término de cada semana.
  • Los Códigos Railway están compuestos de 12 caracteres alfanuméricos (sin importar si son mayúsculas o minúsculas).
  • La marca acceda vía POST a la siguiente URL:

    http://admin.railway.mx/api

Estructura de comunicación del API:

curl -X POST \
-H "Content-Type: application/json" \
'http://admin.railway.mx/api' \
-d '{"clave":"< Token >"}';

Respuesta de éxito:
{
 error":false,
 "codigos":[
  {"codigo":"codigo1"},
  {"codigo":"codigo2"}
 ]
}


Respuesta de error por inexistencia de códigos Railway:
{
 "error":true,
 "message":"Sin códigos"
}


Respuesta de error por uso de Token incorrecto:
{
 "error":true,
 "message":"Clave invalida"
}