Manual del usuario para Interfaz de Programación de Aplicaciones para Feeds. |
Si Usted tiene cualquier sugerencia sobre facilitar el método de trabajo con nuestra API, no dude en contactar con nosotros a feeds@dealerlogin.co
La API basada en Protocolo de Acceso a Objeto Simple (SOAP) y Lenguaje de Descripción de Servicios Web (WSDL).
Por favor tenga en cuenta que todas las acciones y comandos de la Interfaz de Programación de Aplicaciones son reguladas por asociación especial con KeyToken, que puede conseguirse una vez enviada la solicitud vía e-mail a feeds@dealerlogin.co Sin esta llave, las herramientas de la API no estarán disponibles.
Ésta Interfaz de Programación de Aplicaciones contiene únicamente los dos siguientes servicios más esenciales:
- Servicio Vehículo - permite el acceso a un entero stock de vehículos que está disponible al socio KeyToken; comprobación sobre cualquier anuncio de un vehículo seleccionado usando su identificador único de vehículo; proporciona una lista de posibles valores para los campos, etc...
- Servicio Lead – permite publicar las solicitudes a un seleccionado vehículo, usando su identificador único de vehículo, y comprobar las solicitudes dentro de la base de datos de Dealer Login a la vez que proporciona la información a la Concesionaria de Autos. Todas las solicitudes son marcadas cómo provenientes de su base de datos o sitio web..
Servicio Vehículo
Ejemplo de usoÉste servicio contiene las siguientes funciones:
-
$client->getVehicles();
Descripción: Rellena todo el stock de vehículos disponible para el socio KeyToken. Los registros de vehículos vendidos o eliminados no se muestran. URL para el cliente Soap: https://www.dealerlogin.co/za/wsdl-service/vehicles Retorno: Conjunto de vehículos que es un conjunto que contiene elementos del vehículo. Cada Vehículo tiene los siguientes campos: Nombre Descripción VehicleID Identificador único de vehículo VehicleType Tipo de vehículo (condición) auto nuevo auto usado, motocicleta, etc... VehicleBrand Marca del vehículo VehicleModel Modelo del vehículo sin detalles adicionales VehicleUserModel Modelo del vehículo con detalles adicionales p.e. 1.6TDi exclusive VehicleYear Año de registro del vehículo VehicleMileage Kilometraje del vehículo (km) VehicleBodyType Tipo de vehículo p.e. sedan, coupé, etc... VehicleTransmission Tipo de transmisión del vehículo p.e. Automático o Mecánico VehicleFuel Tipo de combustible del vehículo p.e gasolina, diesel VehicleEngine Cilindrada del vehículo (cm3) VehiclePrice Precio del vehículo VehicleColour Color del vehículo VehicleDrivingSide Lado de conducción original p.e. derecha, izquierda VehicleTraction Tracción del vehículo p.e. delantera, trasera, 4x4, 4x2 VehicleWarranty Texto libre para detalles de garantía del vehículo VehicleFinance Si hay disponible financiación del vehículo VehicleServicePlan Texto libre para detalles de servicio del vehículo VehicleMotorPlan Texto libre para detalles de mantenimiento del vehículo VehicleHistory Muestra el libro de mantenimiento del vehículo MMCode Vehicle’s Transunion Mead & McGrouther code VehicleExtras Extras del vehículo p.e. AC, ABS, Techo solar (separados por comas) Comments Text libre para información del vehículo PostDate Fecha de creación del anuncio del vehículo VehiclePhotos El conjunto de URL;s con las fotografías completas del vehículo
Un conjunto de Concesionarias de Autos está disponible para cada vehículo que contiene los detalles de la Concesionaria. Los campos se muestran cómo a continuación::Nombre Descripción ID Identificador único de la Concesionaria Name Nombre de la Concesionaria Region Departamento o región de la Concesionaria City Ciudad de la Concesionaria Email E-Mail de la persona a contactar para información acerca del vehículo (puede ser múltiple, separación con comas) CellPhoneNumber Número de móvil o celular de la persona a contactar sobre el vehículo PhoneNumber Número de teléfono de la Concesionaria ContactPerson El Número de teléfono a contactar para info sobre el vehículo -
$client->isAvailable($VehicleID);
Descripción: Comprobando si el vehículo seleccionado está disponible en stock.. URL para el cliente Soap: https://www.dealerlogin.co/za/wsdl-service/vehicles Parámetros: Nombre Descripción VehicleID Identificador único de vehículo Retorno: True si está disponible False si no está disponible -
$client->getPossibleValues($ElementName);
Descripción: Retorno de la lista de posibles valores URL para el cliente Soap: https://www.dealerlogin.co/za/wsdl-service/vehicles Parámetros: Nombre Descripción ElementName El nombre del campo dentro del conjunto de vehículos p.e. Marca del Vehículo, Tipo de chasis del vehículo, Región Retorno: Conjunto de los posibles valores actuales para le nombre del campo seleccionado -
Ejemplo de cómo usar un Servicio Vehículo:
$header = new SoapHeader('http://tempuri.org/', 'KeyToken', 'XXXX-XXXX-XXXX-XXXX');
$client = new SoapClient("https://www.dealerlogin.co/za/wsdl-service/vehicles");
$client->__setSoapHeaders($header);
$vehicles = $client->getVehicles();
foreach($vehicles as $vehicle) {
echo $vehicle->VehicleID;
}
var_dump($vehicles);
Servicio Lead
Ejemplo de usoÉste servicio contiene las siguientes funciones:
-
$client->sendLead($Lead);
Descripción: Crea un “ Lead “ basado en la solicitud de un cliente, lo muestra junto con la fuente de la solicitud (p.e. OLX) en el sistema de Dealer Login y envía al vendedor privado o Concesionaria de autos el mensaje de solicitud a su e-mail y por SMS a su móvil.. URL para el cliente Soap: https://www.dealerlogin.co/za/wsdl-service/leads Parámetros: El conjunto del Lead con los detalles de contacto del cliente y el número único identificador del vehículo. El conjunto del Lead contiene los siguientes campos: Nombre Descripción VehicleID El número único identificador del vehículo por el cuál el cliente se interesó. Requerido. CustomerName Nombre del cliente que generó el lead (solicitud). Requerido. CustomerSurname Apellidos del cliente que generó el lead (solicitud) CustomerRegion Departamento o Región desde la cuál el cliente generó el lead (solicitud). Requerido. CustomerPhone Teléfono de contacto del cliente que generó el lead (solicitud). Requerido. CustomerEmail E-mail del cliente que generó el lead (solicitud). Requerido. CustomerMessage Comentarios del cliente LeadCreatedDate El timestamp de Unix del lead que fue creado.. isMobile Es Mobile Mark cuando el Lead ha sido creado desde un teléfono móvil True / False.
False por defecto..CustomerIP Dirección IP del cliente que generó el lead (solicitud). Retorno: Retorna un elemento de resultado que contiene los siguientes campos: Nombre Descripción Message Si ocurre un error, el campo del mensaje contendrá un mensaje de error. En caso de no error, un mensaje de compleción exitosa será mostrado. Success Indica si el Lead ( Solicitud ) ha sido enviado exitosamente. Retorna True para éxito y False para fallo.. -
$client->sendRequest($Lead);
Descripción: Crea una solicitud basada en la consulta de un usuario, la publica en el sistema de DealerLogin y envía el mensaje de notificación a las Concesionarias o Playas de autos vía correo electrónico. URL para el cliente Soap: https://www.dealerlogin.co/za/wsdl-service/leads Parámetros: El conjunto del Lead con los detalles de contacto de la persona que busca un auto específico. El conjunto del lead contiene los siguientes campos:: Nombre Descripción CustomerName Nombre de la persona que ha creado la solicitud. Requerido.. CustomerPhone Número de teléfono de la persona que ha creado la solicitud. Requerido.. CustomerEmail Dirección email de la persona que ha creado la solicitud. Requerido.. CustomerMessage Comentarios del cliente y detalles del vehículo del que se está consultando. Requerido.. LeadCreatedDate El Timestamp Unix que ha sido creado con la solicitud.. isMobile Mark. La solicitud ha sido creada en versión móvil. True / span class='php reserved'>False.
False por defecto..CustomerIP La dirección IP de la persona que ha creado la solicitud. Retorno: Retorna un elemento de resultado que contiene los siguientes campos: Nombre Descripción Message Si ocurre un error, el campo del mensaje contendrá un mensaje de error. En caso de no error, un mensaje de compleción exitosa será mostrado. Success Indica si la solicitud ha sido enviada exitosamente. Retorna True para éxito y False para fallo.. -
Ejemplo de cómo usar un Servicio Lead:
$header = new SoapHeader('http://tempuri.org/', 'KeyToken', 'XXXX-XXXX-XXXX-XXXX');
$client = new SoapClient("https://www.dealerlogin.co/za/wsdl-service/leads");
$client->__setSoapHeaders($header);
$Lead = $client->Lead;
$Lead->VehicleID = 255464;
$Lead->CustomerName = "Patrick";
$Lead->CustomerSurname = "Kabelo";
$Lead->CustomerRegion = "Gauteng";
$Lead->CustomerPhone = "0785582367";
$Lead->CustomerEmail = "example@gmail.com";
$Lead->CustomerMessage = "I'm interested in this car. Please call me!";
$Lead->LeadCreatedDate = time();
$Lead->CustomerIP = $_SERVER[REMOTE_ADDR]
$result = $client->sendLead($Lead);
var_dump($result);
Si Usted tiene cualquier sugerencia sobre facilitar el método de trabajo con nuestra API, no dude en contactar con nosotros a feeds@dealerlogin.co