Una Introducción a los servicios web Vtiger

Vtiger proporciona una interfaz de programación de aplicación sencilla, potente y seguro (API) para trabajar con entidades almacenados en ella. Para utilizar este documento, usted debe tener un conocimiento básico de desarrollo de software, servicios web, y el Vtiger CRM. Los servicios Web proporcionan una forma más fácil de integrar VTiger con sus otros sistemas de software.

características de llamada API

  • REST - API está basada en REST, por lo que toda la comunicación b/w cliente y el servidor puede pasar a través de HTTP como GET o POST peticiones.

  • JSON - JSON se utiliza para codificar la respuesta y la petición.

  • Solicitudes y respuestas - Su aplicación cliente prepara y presenta una solicitud de servicio a la API, la API procesa la solicitud y devuelve una respuesta, y la aplicación cliente se encarga de la respuesta.

  • Comprometido automáticamente - Cada operación que escribe a un objeto VTiger se ha comprometido de forma automática. Esto es análogo a la AUTO COMMIT configuración en SQL.

Respuesta API

Objeto respuesta

Todas las respuestas tendrán el siguiente formato.

Si la solicitud se procesa correctamente.

<code> Response{
    success:Boolean=true
    result:Object //The Operation Result object
    }
</code>

Si se produce un fallo al procesar la solicitud,

<code> Response{
    success:Boolean=false
    error:ErrorObject    }
</code>

Error Objecto

<code> ErrorObject{
    errorCode:String //String representation of the error type
    errorMessage:String //Error message from the api.
}
</code>

Código de error es una representación de cadena del tipo de error.

Manejo del Error

La respuesta a cualquier solicitud de servicio web es un objeto JSON. El objeto tiene un éxito campo que tiene el valor true si la operación fue un éxito y false en caso contrario. Si el éxito es falso el objeto respuesta contendrá un error de campo que contendrá objeto JSON. El objeto de error contendrá dos campos Tipo de error, una sola descripción de la palabra del error, y el error de error, una cadena que contiene una descripción del error. El código de ejemplo está escrito en PHP y tiene dos dependencias de la biblioteca Zend JSON y Http_Client.