Nota previa: este documento se describe detalles técnicos de integración de leads por el mecanismo de API Rest y requiere conocimiento técnicos de programación de sistemas.
Tecnom Nubux permite el ingreso de leads digitales a través de au API de integración de leads. Para conocer mas acerca de los fundamentos y conceptos de API Rest consulte este link
Seguridad y autenticación
El acceso a la API se realiza sobre HTTPS, y toda la información recibida y enviada se transmite en formato JSON. La autenticación se realiza utilizando el método de autenticación Basic de HTTP. Para obtener un usuario y contraseña con permisos para utilizar la API contactarse con soporte@tecnom.com.ar
Entrada de API y URL
La ruta relativa de la entrada de leads por API es POST /api/v1/webconnector/consultas/adf
La URL absoluta para la entrada de API, responde al formato https://concesionarioID.tecnomcrm.com/api/v1/webconnector/consultas/adf y para los casos de testeos cuenta con un ambiante de QA para pruebas y cuya URL responde al formato https://test-concesionarioID.tecnomcrm.com/api/v1/webconnector/consultas/adf
Cada concesionario tiene un subdominio asociado en la URL (concesionarioID). Esta información y ruta absoluta de entrada de API será importante verificarla y acordarla con nuestro equipo de soporte (soporte@tecnom.com.ar) al momento de ingresar a producción.
Request
El formato del lead está basado en el estándar Auto-lead Data Format (ADF) y la especificación de los campos que pueden enviarse, con sus validaciones, se detallan en el anexo al final del documento.
Ejemplo
{
"prospect": {
"requestdate": "2017-09-29T18:48:45.857161Z",
"customer": {
"comments": "Se puede abonar en efectivo en lugar de financiado?",
"contacts": [
{
"emails": [
{
"value": "vane.auto@gmail.com"
}
],
"names": [
{
"part": "first",
"value": "Vanesa Elizabeth"
},
{
"part": "last",
"value": "Perez"
}
],
"phones": [
{
"type": "cellphone",
"value": "113626544299"
}
],
"addresses": [
{
"city": "Córdoba",
"postalcode": "X5022"
}
]
}
]
},
"vehicles": [
{
"make": "Marca",
"model": "Modelo",
"trim": "Version",
"year": 2017
}
],
"provider": {
"name": {
"value": "Google Adwords"
},
"service": "Campaña Planes Primavera"
},
"vendor": {
"contacts": [],
"vendorname": {
"value": "vendedor@email.com.ar"
}
}
}
}
Response
Si la respuesta fue correcta, se retorna el identificador de la consulta creada en Tecnom Nubux.
HTTP Status Code: 201 Created
{
"id": 388592
}
Respuesta si ocurrió un error de validación
HTTP Status Code: 400 Bad Request
{
"Message": "Ha ocurrido un error al validar la consulta",
"ModelState": { "dto.prospect.id": ["Ya existe una consulta con id: 116554387"] }
}
Anexo - Campos del leads (ADF)
AdfProspect: object |
|
id: AdfId requestdate: string (date-time) Fecha y hora en la cual el lead fue generado vehicles: AdfVehicle[] Describe el vehículo que le interesa al cliente customer: AdfCustomer required Información acerca del cliente provider: AdfProvider required Usado para identificar el proveedor del servicio que originó la consulta. vendor: AdfVendor Proporciona información sobre el vendedor que el cliente ha solicitado servicio, es decir, el receptor del lead. |
AdfCustomer: object |
|
contacts: AdfContact[] required comments: string |
AdfContact: object |
|
primarycontact: boolean names: AdfContactName[] emails: AdfContactEmail[] Se debe incluir al menos un dato de contacto, sea email o telefono phones: AdfContactPhone[] Se debe incluir al menos un dato de contacto, sea email o telefono addresses: AdfContactAddress[] |
AdfContactName: object |
|
part: string , x ∈ { first , middle , suffix , last , full } type: string , x ∈ { individual , business } value: string |
AdfContactEmail: object |
|
value: string |
AdfContactAddress: object |
|
street: string apartment: string city: string regioncode: string postalcode: string country: string type: string , x ∈ { work , home , delivery } |
AdfContactPhone: object |
|
type: string , x ∈ { phone , fax , cellphone } value: string |
AdfId: object |
|
sequence: integer (int32) source: string value: string |
AdfProvider: object |
|
name: AdfContactName required service: string |
AdfVehicle: object |
|
year: integer (int32) make: string required model: string required trim: string vin: string transmission: string stock: string odometer: integer (int32) comments: string interest: string , x ∈ { sell , buy , trade_in , lease } status: string , x ∈ { new , used } |
AdfVendor: object |
|
id: AdfId vendorname: AdfContactName contacts: AdfContact[] |
Comentarios
0 comentarios
El artículo está cerrado para comentarios.