Alta de contactos (Web Sertvice CRM)


Bienvenido a la documentación de referencia para el webservice de alta de contactos. A continuación te explicaremos todos los datos básicos y/o necesarios para poder dar de alta un contacto en el CRM a través del webservice.

Lo primero que necesitamos es el obtener nuestro apikey del CRM. Este lo puedes obtener en el perfil del administrador del negocio en Community. Solo debe de entrar a Perfil / Cuenta de servicios / Apikey. Si ya has generado tu apikey única se te mostrará, el cual tiene una estructura como la siguiente: key_a1b2c3d4e5f6g7h8i9j10k11l12m13n14o. Si aun no la tienes haz clic en el botón Generar para obtenerla. El apikey es necesario para usar el webservice, sin el no podrás realizar ningún proceso correctamente.

Una vez tengas tu apikey ya puedes continuar.

Estructura general del webservice

Para enviar y recibir datos se usa la estructura JSON. El envío es por medio del metodo HTTP POST por un único parámetro llamado "data".
Ejemplo de código basico de envío:

{
  "c":{
    "header":{
      "Cn_Cve_Contacto":"",
      "Cn_descripcion":"Jose Ponce",
      "Cn_Email":"jose.ponce@midominio.mx"
    }
  },
  "m":{ 
    "action":"201",
    "provider":"contact",
    "apikey":"key_a352ab94122fb68a3fef5f52c4df45e241e0"
  }
}

Ejemplo de código avanzado de envío:

{
  "c":{
    "header":{
      "Cn_Cve_Contacto":"",
      "Cn_Descripcion":"Jose Ponce",
      "Cn_Organizacion":"",
      "Cn_Cargo":"",
      "Cn_Email":"jose.ponce@midominio.mx",
      "Cn_Direccion_1":"",
      "Cn_Direccion_2":"",
      "Cn_Direccion_3":"",
      "Cn_Ciudad":"",
      "Cn_Estado":"",
      "Cn_Pais":"",
      "Cn_Telefono_1":"",
      "Cn_Telefono_2":"",
      "Cn_Telefono_3":"",
      "Cn_Telefono_4":"",
      "Cn_Sitio_Web":"",
      "Cn_Notas":"",
      "Cn_Nombre":"",
      "Cn_Apellido_Paterno":"",
      "Cn_Apellido_Materno":"",
      "Cn_Ocupacion":"",
      "Cn_Sexo":"",
      "Cn_Departamento":"",
      "Cn_Empresa":"",
      "Cn_Empleados":"",
      "Cn_Fecha":"",
      "Cn_Hora":"",
      "Cn_Fecha_Nacimiento":"20000101",
      "Cn_Edad":"25",
    }
  },
  "m":{ 
    "action":"201",
    "provider":"contact",
    "apikey":"key_a352ab94122fb68a3fef5f52c4df45e241e0"
  }
}

Respuesta del servidor

Al consumir el servicio y enviar un código válido json, el servidor te respondera con un archivo JSON, el cual tiene su estructura similar al envío.
Ejemplo de código de respuesta:

{
  "c": {
    "obj": {
      "Cn_Cve_Contacto": "0000050000",
      "Cn_Descripcion": "Jose Ponce",
      "Cn_Email": "jose.ponce@midominio.mx",
      "State": "Update complete"
    }
  },
  "m": {
    "type": "info",
    "code": "200",
    "detail": "process complete"
  }
}

Ejemplo de código con error:

{
  "c": {},
  "m": {
    "type": "error",
    "code": "405",
    "detail": "Add_Contact - the field [Cn_Descripcion] of the object [c][header] is requiered"
  }
}


¿Te resulto útil esta información?
0% de las personas consideraron que fue útil.



Iniciar una conversación en el foro de soporte de nuestra comunidad


Hacer una pregunta al foro

Más recursos

Site

Conoce nuestras diferentes Soluciones de Software. ¡Contáctanos!

Blog

Artículos, noticias y consejos útiles sobre tecnología y Sistemas Administrativos.


Community

Plataforma con múltiples recursos de ayuda y herramientas de soporte.




Contacta a un experto

¿Como podemos ayudarte?

Optén soporte personalizado por télefono o chat.


Obtener soporte