1. Casa
  2. Preguntas frecuentes
  3. /
  4. Funcionalidad avanzada
  5. /
  6. Configurar Simply
  7. /
  8. Documentación de API y servicio web Simply CRM

Documentación de API y servicio web Simply CRM

Esta documentación describe la interfaz de programación de aplicaciones basada en REST (la API) publicada por Simply CRM . Está destinado a ser un documento de referencia para todos los que utilizan nuestras API.

Le recomendamos que siga el tutorial antes de intentar leer esta documentación.

Todos los datos estructurales, incluida la respuesta de la API, se representan como cadenas JSON.

Cada entidad tiene un ID con formato especial que se puede usar para buscar el tipo de entidad y el registro. Crear es el único caso que no requiere una identificación.

 http: //Simply_url/webservice.php? operation = [tipo de operación] & sessionName = [nombre de sesión] & [parámetros específicos de la operación]

Actualmente, Simply CRM admite las siguientes operaciones:

  • conseguir desafío
  • iniciar sesión
  • crear
  • recuperar
  • actualizar
  • Eliminar
  • sincronizar
  • consulta
  • tipos de lista
  • describir
  • cerrar sesión
  • extender la sesión

SessionName

La clave que se utiliza para identificar de forma exclusiva la sesión actual. Esta información debe enviarse al servidor como parte de cada solicitud.

servicio web

La API del servicio web admite el modelo de seguridad seguido en la interfaz de usuario web de Simply.

El proceso de inicio de sesión utiliza un esquema de desafío / respuesta de dos pasos.

Tipos de datos usados por la API

Todas las respuestas tendrán el formato que se muestra a continuación. Si la solicitud se procesa correctamente, el formato es:

Si ocurre una falla mientras se procesa la solicitud, recibirá el siguiente formato de respuesta:

 Respuesta {
éxito: booleano = verdadero
result: Object // El objeto Result
}
 Respuesta {
éxito: booleano = falso
error: ErrorObject
}
 ErrorObject {
errorCode: String // Representación en cadena del tipo de error
errorMessage: String // Mensaje de error de la api
}

ErrorCode es una representación de cadena del tipo de error.

SimplyObject

SimplyObject es un mapa que representa el contenido de un objeto basado en una entidad crm. Todos los campos de referencia utilizan el tipo de ID, que asigna un número único a cada objeto. Este campo está presente para todos los objetos extraídos de la base de datos.

Formato de identificación

 objectTypeId 'x' objectId

objectTypeId: ID del tipo de objeto. Esto se genera de forma única para cada entidad admitida por la API del servicio web y se devuelve como resultado de la operación de descripción como idPrefix.

objectId: id del objeto en la base de datos. Esta es una identificación global única para los objetos de la entidad dada.

Mapa

Una matriz asociativa de pares clave-valor. Normalmente se utiliza en la operación de creación.

TimeStamp

Una representación larga del número de segundos desde la época de Unix.

Operaciones

Iniciar sesión

El inicio de sesión es un proceso de dos pasos: primero, generamos un token único que llama a getChallenge. Y luego use ese token y nuestra clave de acceso única para generar una ID de sesión que actúa como un identificador de autenticación.

Obtener desafío

Se usa para obtener una ficha de desafío del servidor.

Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know.

Esta debe ser una solicitud POST.

Formato de URL

 http: //Simply_url/webservice.php? operation = extendedession

Entidades CRM

Lo que sigue es la lista de entidades CRM expuestas por la API.

Nombre Descripción
Calendario El módulo Calendario se utiliza para gestionar tareas, eventos y reuniones.
Guías El módulo de clientes potenciales se utiliza para realizar un seguimiento de los clientes potenciales de ventas.
Cuentas El módulo Cuentas se utiliza para administrar personas u organizaciones involucradas con su negocio.
Contactos El módulo Contactos se utiliza para administrar las personas que pueden estar asociadas con una cuenta.
Potenciales El módulo de potenciales se utiliza para gestionar oportunidades de ventas.
Productos El módulo Productos se utiliza para administrar los productos que vende su organización.
Documentos El módulo Documentos se utiliza para administrar los documentos y notas cargados.
Correos electrónicos El módulo de correos electrónicos es un cliente de correo electrónico que se utiliza para administrar sus correos electrónicos.
Mesa de ayuda El módulo HelpDesk se utiliza para realizar un seguimiento de los problemas de los clientes, como comentarios, problemas, etc.
Preguntas más frecuentes El módulo de preguntas frecuentes se utiliza para gestionar las preguntas frecuentes planteadas por sus clientes.
Vendedores El módulo de proveedores se utiliza para administrar fabricantes y productores.
PriceBooks El módulo PriceBook se utiliza para administrar los precios de los productos.
Citas El módulo Cotizaciones se utiliza para gestionar cotizaciones de productos.
Orden de compra El módulo PurchaseOrder se utiliza para administrar y procesar los pedidos de compra.
Órdenes de venta El módulo SalesOrder se utiliza para administrar y procesar pedidos de venta.
Factura El módulo Factura se utiliza para crear informes de facturas.
Campañas El módulo Campañas se utiliza para gestionar campañas de marketing.
Eventos El módulo Eventos se utiliza para gestionar actividades como llamadas y reuniones.
Usuarios El módulo Usuarios se utiliza para administrar los usuarios de CRM.
Grupos Grupos de usuarios en Simply CRM .
Moneda El módulo de moneda permite al administrador definir diferentes monedas y establecer las tasas de conversión esperadas con respecto a la moneda base. Estas monedas se pueden utilizar en el módulo Inventario para admitir varias monedas.
Carpetas de documentos El módulo DocumentFolders se utiliza para agrupar documentos.

Tipos de campo

Lista de selección

Un campo que puede contener uno de una lista de valores, en cuyo caso el mapa contendrá dos elementos: picklistValues, que es una lista de valores posibles, y defaultValue, que es el valor predeterminado para la lista de selección.

Nombre Descripción
picklistValues Representa la lista de valores posibles.
valor por defecto Especifica qué valor debe utilizarse como valor predeterminado para la lista de selección.
nombre El nombre del tipo de campo.

Referencia

Un campo que muestra una relación con otro objeto. El mapa de tipo de campo contendrá otro elemento llamado referTo, que es una matriz que contiene los módulos a los que puede apuntar el campo.

Nombre Descripción
se refiere a Una matriz que contiene los módulos a los que puede apuntar el campo.
nombre El nombre del tipo de campo.

Fecha y hora

Una cadena que representa la fecha y la hora, el formato se basa en el formato de fecha de configuración del usuario.

Fecha

Cadena que representa una fecha. El mapa de tipo de campo contendrá otro elemento llamado formato , que especifica el formato esperado del valor del campo, según la configuración del formato de fecha del usuario.

Nombre Descripción
formato El formato esperado del valor del campo.
nombre El nombre del tipo de campo.

Texto

Un campo de texto de varias líneas.

Hora

Una cadena con el formato hh: mm, que se basa en la configuración del formato de hora del usuario.

Cuerda

Un campo de texto de una línea.

Booleano

Un campo booleano, que solo puede tener los valores verdadero o falso .

Entero

Un campo numérico no decimal.

Propietario

Un campo que se utiliza para definir el propietario del campo. Puede ser un grupo o un usuario individual.

Auto generado

Campos, como el ID del objeto, cuyos valores son generados automáticamente por Simply.

Correo electrónico

Un campo utilizado para almacenar ID de correo electrónico.

Teléfono

Un campo utilizado para almacenar números de teléfono.

URL

Un campo para almacenar URL.

Doble

Un campo para números de coma flotante.

Archivo

Un campo utilizado para agregar archivos a Simply.

Nombre Descripción
maxUploadFileSize El tamaño máximo permitido para cargar archivos.
nombre El nombre del tipo de campo.

Contraseña

Un campo utilizado para almacenar contraseñas.

Decimal

Un campo utilizado para números de coma flotante.

Skype

Un campo que se utiliza para almacenar ID de Skype o números de teléfono.

Lista múltiple

Un campo de lista de selección donde se pueden seleccionar varios valores.

Problemas conocidos

La sincronización no funciona en el módulo Usuarios y módulos que no son entidades como Moneda, Grupos, etc.

La consulta no funciona en módulos que no son entidades como Moneda, Grupos, etc.

Actualizado en 18/11/2020

¿Te resultó útil este artículo

Artículos relacionados