Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Que es Colppy REST API?

...

{
...

     "service": {
            "provision": "Usuario",
            "operacion": "iniciar_sesion"
      },

...
}
 

 

Una cosas con la que hay que tener mucho cuidado es que el nombre de las provisiones y operaciones son sensible a mayúsculas. Siempre tener el Indice de provisiones y operaciones a mano. En parameters van los parametros que espera la operacion para poderse ejecutar. Estos parámetros varían de provision en provision y de operacion en operacion. En este caso estamos tratando de iniciar sesion en colppy, si nos fijamos en el indice de provisiones y operaciones en la seccion de la provision sesion, podemos ver los parametros que espera la operacion en el JSON.

En el nuestro ejemplo el JSON final quedaría de la siguiente manera:

...

{
      "auth": {
            "usuario": "SujetoDePrueba",
            "password": "SujetoDePruebaContraseña"
      },
      "service": {
            "provision": "Usuario",
            "operacion": "iniciar_sesion"
      },
      "parameters": {
            "sesion": {
                  "usuario": "UsuarioTest",
                  "claveSesion": "ContraseñaTest"
            },
      }
}

 

Una vez que ejecutamos la HTTP POST Request con nuestro JSON, Colppy REST API nos va a responder con un mensaje informándonos si el requerimiento se realizo con éxito o no.   

Ejemplo de una respuesta de éxito:

 

{
      "service":{
            "provision":"Usuario",
            "operacion":"iniciar_sesion",
            "version":"1_0_0_0",
            "response_date":"2014-24-06 17:10:19"
      },
      "result":{
            "estado":0,
            "mensaje":"La operaci\u00f3n se realiz\u00f3 correctamente"
      },
      "response":{
            "success":true,
            "message":"La operacion se realizo con exito.",
            "data":{
                  "claveSesion":"b5a97564ad59e624a6ba545ecd3ca112"
            }
      }
}