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 utilizar 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
- acceso
- 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 es compatible con 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
resultado: Objeto // El objeto Resultado
} 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 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
Acceso
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.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
Formato de URL
http: //Simply_url/webservice.php? operation = query & sessionName = [id de sesión] & query = [cadena de consulta]
Sincronizar
Sync devolverá un objeto SyncResult que contiene detalles de los cambios después de modifiedTime.
sync (modifiedTime: Timestamp, elementType: String): SyncResult
Pedido
Tipo : OBTENER
modifiedTime: La hora de la última modificación sincronizada. ElementType: Este es un parámetro opcional, si se especifican los cambios para ese módulo después del tiempo dado, de lo contrario, se devuelven los cambios en todos los módulos accesibles al usuario.
Respuesta
SyncResult { updated:[Object] //List of Objects created or modified. deleted:[Id] //List of *Id* of objects deleted. lastModifiedTime:Timstamp //time of the latest change. which can used in the next call to the Sync api to get all the latest changes that the client hasn't obtained. }Esta debe ser una solicitud GET.
Formato de URL
http: //Simply_url/webservice.php? operation = sync & sessionName = [id de sesión] & modifiedTime = [marca de tiempo] & elementType = [elementType]
Cerrar sesión
Cierre la sesión de servicio web, lo que deja la sesión de servicio web no válida para su uso posterior.
logout (): Mapa
Tipo de solicitud: GET Devuelve un mapa que contiene la clave 'mensaje' con el valor 'exitoso'.
Esta debe ser una solicitud GET.
Formato de URL
http: //Simply_url/webservice.php? operation = logout & sessionName = [id de sesión]
Tipos de lista
Enumere los nombres de todos los objetos Simply disponibles a través de la API.
listtypes (): Mapa
Tipo de solicitud: OBTENER
Devuelve un mapa que contiene la clave 'tipos' con el valor de una lista de nombres de objetos Simply.
Esta debe ser una solicitud GET.
Formato de URL
http: //Simply_url/webservice.php? operation = listtypes & sessionName = [id de sesión]
Describir
Obtenga la información de tipo sobre un objeto Simply dado.
describe (elementType: String): DescribeResult
Tipo de solicitud: OBTENER
elementType: el nombre de tipo del objeto Simply que se va a describir.
Devuelve una instancia de DescribeResult.
Esta debe ser una solicitud GET.
Formato de URL
Ampliar sesión
Extiende la sesión web actual de Simply al servicio web y devuelve el ID de sesión del servicio web.
Extendedession (nombre de usuario: String): LoginResult
Tipo de solicitud: POST
nombre de usuario: un nombre de usuario de Simply.
Esta debe ser una solicitud POST.
Formato de URL
http: //Simply_url/webservice.php? operation = extensionsession
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. |
| Dirige | 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 las 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 que plantean 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 . |
| Divisa | 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 de 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 se debe utilizar 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.
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.
Dueño
Un campo que se usa 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 usa para almacenar ID de Skype o números de teléfono.
Lista de selección 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.
