Referencias API

Integración simplificada

Aproveche todas las ventajas de nuestra plataforma, con los productos relacionados se puede obtener el máximo provecho y así conseguir de mejor manera cumplir con su tarea del día.

Requiero apoyo...

Una de las funcionalidades más importantes del conjunto de instrucciones para la conectividad que ofrece la plataforma, es el API Client Library vía WebService

La última versión del ACL se llama VENOM, esta versión permite que los usuarios técnicos puedan interfasar sus sistemas de manera directa con la Plataforma de Servicios Integrados GreyPhillips.

Antes de empezar es importante tener en cuenta algunos conceptos básicos:

Término Descripción
PSI Plataforma de Servicios Integrados
Dominio Un dominio es la suma de los datos relacionados a un único cliente final que incluye la base de datos, rutas físicas, servicios y acuerdos particulares
ACL API Client Library
VENOM Versión del ACL vigente 2020
GUID Es un valor representado por un conjunto de números, letras y guiones único que representa algo, en su totalidad, por ejemplo, un contacto, una cuenta, una campaña, etc.
COB Nomenclatura para referirse a Continuidad de Negocios, también relacionada a Fail Over y Servidores Espejo.

Los servicios de la plataforma están separados en dos unidades funcionales, las cuales son parte de la arquitectura misma y su propósito es administrar dos ámbitos de información que, aunque funcionan en conjunto, existen como componentes separados, estas dos porciones son: 

  1. La gestión de información funcional, por ejemplo, la información de los contactos, la información relacionada a la reporteria, la administración de otras aplicaciones de la plataforma que no forman parte de este documento y cualquier otra información funcional o información de base pasiva relacionada a conceptos COB.
  2. La gestión operativa de las comunicaciones separadas geográficamente por país/región, según sean estas necesarias, por ejemplo, para los SMS, puede que según el país/región exista infraestructura implementada para lograr los propósitos de envíos locales de SMS.

Un ejemplo de estas dos estructuras es cuando un cliente tiene su base de datos funcional, es decir, su información de contactos, resultados de las campanas hechas en su base de datos en Canadá, pero se utilizan los servidores de envío de SMS implementados en Guatemala, ambas bases de datos, son en última instancia parte del mismo ambiente protegido del cliente.

Para los propósitos de este documento, el primer vínculo se usa para el registro del contacto en la base de datos y el segundo vínculo sirve a los propósitos específicos de las comunicaciones, es decir, el registro de los envíos en la PSI, aunque al final toda la información estará sincronizada y resguardada bajo el mismo dominio destinado para el cliente.

Bases para la utilización del ACL

Toda conexión que se haga a la plataforma debe pasar por las validaciones de seguridad que han sido dispuestas para asegurar que únicamente personas y sistemas autorizados son los que estén tratando de operar dentro de los límites de la plataforma.

Cada cliente final tiene una base de datos independiente dentro de la plataforma, esto con el fin de cumplir con los requerimientos de seguridad que solicitan los estándares de manejo de confidencialidad de la información, haciendo una separación lógica y física de la información, por tal motivo cada cliente final de la plataforma tendrá asignada una llave única de identificación para su dominio particular.

Usted como programador, deberá conocer la llave de identificación que le es asignada para uso de los Web Services, esta llave de identificación es asignada por base de datos, así que no es posible utilizar una llave de identificación para hacer la conexión con otra base de datos distinta.

La llave de identificación es necesaria para todas las funcionales del ACL y le será entregada por separado para cada base de datos y estas se asignan a cada base de datos en el momento de su creación, la misma puede ser cambiada si existieran sospechas de que la misma está siendo usada sin autorización, por medio de una solicitud al departamento de soporte.

Esta llave corresponde a un dato alfanumérico de 36 caracteres, conocida como GUID o Global Unique Identifier, lo cual la hace virtualmente irrepetible, si se genera usando medios electrónicos, excluyendo el evidente copiado y la asignación directa.

Todas las funciones adicionalmente requieren de un usuario y contraseña establecida dentro de cada base de datos, es decir, antes de poder utilizar las funciones del ACL, usted debe de crear un usuario que quiera que sea el autorizado, en caso de que se quiera más información acerca de cómo crear estos usuarios, puede referirse al Panel de Control de la plataforma y al manual de administración de usuarios.

Una vez que tiene en su poder, tanto la llave de identificación como el usuario y contraseña que se le haya asignado, está listo para integrar el ACL a sus propios proyectos.

Empezar

Por favor revise este apartado antes de continuar, continente información importante relacionada a como empezar a utilizar los servicios web disponibles.

Leer mas...

Métodos disponibles en las ACL:

https://cloud.greyphillips.com/apis/soap/venom/acl.asmx
Métodos Descripción
getAgendaAvailable Get data available from agenda vs CCE. Return OK or ERROR
getCNX Devuelve los datos de conexion para la base dada en XML
getCNXData Devuelve los datos de conexion para la base dada
getCNXInfo Devuelve los datos infomativos de la base dada
getCNXPKbyName Devuelve el PK de conexion para la base dada
getCNXbyPK Devuelve los datos de conexion para el PK de la base dada
getCatalogProdImgs Retorna las imagenes de los productos para el filtro dado
getCatalogProdStock Retorna las cantidades en las bodegas de los productos para el filtro dado
getCatalogProds Retorna los productos activos del catalogo para los filtros dado
getConfig
Get data from configuration. Return OK or ERROR
getContact Contacts: get contact data from public storage. Return data or ERROR
getContactAddress Contacts: get contact data from public storage. Return data or ERROR
getContactAdvanced Contacts: get contact data from public storage. Return data or ERROR
getContactCertificateValid Contact: get certificate validation. Return true/false
getContactCustomFieldValue Contact: get custom field/value. Return Dataset
getDateTime Obtener la fecha/hora del servidor según el formato dado
getDocData Consulta de datos a base de datos dada segun intType (Ads=0, Attachments=1, DocsRelated=2, Documents=3, Events=4, GalleryImgFiles=5, GalleryList=6, Notes=7, SegmentsDox=8, Versions=9, GalleryImgs=10, EventsFull=11 y SegmentsDoM=12) 
getEDIConnectATV EDI: verify connection from ATV. Return OK or ERROR
getEDILog EDI: query log document. Return XMLData or ERROR
getEDIStatusfromCloud EDI: query XML document from Cloud. Return Base64String_XMLDocument or ERROR
getEDIXMLfromATV EDI: query XML document from ATV. Return Base64String or ERROR
getEDIXMLfromCloud EDI: query XML document from Cloud. Return Base64String_XMLDocument or ERROR
getERPData Consulta de datos a base de datos dada segun intType
getERPDataDS Consulta de datos a base de datos dada segun intType
getGlobalContact Contacts: get contact data from public storage. Return data or ERROR
getGlobalContactDS Contacts: get contact data from public storage. Return dsData or ERROR
getGlobalContactSIC Contacts: get contact data from public storage (SIC). Return data or ERROR
getGlobalContactSICDS Contacts: get contact data from public storage (SIC). Return data or ERROR
getLicense Devuelve el siguiente contrato válido o ERROR
getQData Devuelve los datos para la base dada
getQueryData Devuelve los datos para la base dada
getSalesRanking Retorna las cantidades en las bodegas de los productos para el filtro dado
getTask Teamwork: get task. Return Dataset
getTaskCustomFieldValue Teamwork: get custom field/value. Return Dataset
getTaskCustomFieldValueXML Teamwork: get custom field/value. Return XML
getToken Security: Get access token. Return token or ERROR
getUserAccess Consulta de permisos de accesos de un usuario
getWhiteLabel Obtiene la información relacionada a un dominio con marca blanca
setAccountingEntry Asiento: Add or update AsientoE header. Return NULL or ERROR
setAccountingEntryD Asiento: Add or update AsientoD line. Return NULL or ERROR
setAgendaEvent Agenda Event: Add or update register. Return NULL or ERROR
setAgendaEventContact Agenda Event contact: Add or delete register. strType={SHR|INF} Return NULL or ERROR
setAgendaEventContactExtended Agenda Event contact: Add or delete register. strType={SHR|INF} Return NULL or ERROR
setAgendaEventExtended Agenda Event: Add or update register. Return NULL or ERROR
setAgendaEventNotify Agenda Event Notification: Add or update register. Return NULL or ERROR
setAppID Add or update AppID data. Return 'OK' or ERROR
setAppIDAdvanced Add or update AppID data. Return 'OK' or ERROR
setAppIDGeoPosition Add or update AppID data. Return 'OK' or ERROR
setBudgetDetail Agrega detalles a los presupuestos
setContact Contacts: Add or edit contact. Return registry ID or ERROR
setContactAddress Contact address: Add or edit contact address. Return registry ID or ERROR
setContactAddressAdvanced  Contact address: Add or edit contact address. Return registry ID or ERROR
setContactAdvanced Contacts: Add or edit contact with aditional info. Return registry ID or ERROR
setContactCustomFieldValue Contact Custon field: edit contact information. Return 'OK' or ERROR
setContactCustomFieldValueCollection Contact Custon field: edit contact information. Return 'OK' or ERROR
setContactException Contacts: Add or update contact exception. Return NULL or ERROR
setContactRelated Relaciona contactos
setCostCenter Vendors: Add or edit contact. Return registry ID or ERROR
setDoXContactRelated DoX: Add/Delete related contact to document. [intAction: 0=Add | 1=Delete
setDoXCustomFieldValue DoX Custon field: edit document information. Return 'OK' or ERROR
setDoXCustomFieldValueCollection DoX Custon field: edit document information. Return 'OK' or ERROR
setDoXDocument DoX Document: Add or update register. Return NULL or ERROR
setDoXDocumentGroup Asignación de grupos a documentos
setDocFileAttach Utils: Add/Delete related file to document. [intAction: 0=Add | 1=Delete
setDocNote Document note. Return 'OK' or ERROR
setEDIControl EDI Documents reference. Return DocumentID or ERROR
setEDIDoc EDI header and document data. Return DocumentID or ERROR
setEDIDocCompactProcess_AA EDI document data. Return DocumentKey or ERROR
setEDIDocCompactProcess_AS EDI Simple document generator: Autopistas del Sol. Return DocumentID or ERROR
setEDIDocCustomFieldValue EDI Documents reference. Return DocumentID or ERROR
setEDIDocDetail EDI detail line. Return DocumentDetailID or ERROR
setEDIDocDetailCode EDI detail codes line. Return strDocDetailProdCodeID or ERROR
setEDIDocDetailAdvanced EDI detail line. Return DocumentDetailID or ERROR
setEDIDocDetailCode EDI detail codes line. Return strDocDetailProdCodeID or ERROR
setEDIDocDetailDiscount EDI detail discount line. Return strDocDetailDiscountID or ERROR
setEDIDocDetailStatus EDI detail line. Return DocumentDetailID or ERROR
setEDIDocDetailTax EDI detail tax line. Return strDocDetailTaxID or ERROR
setEDIDocDetailTaxEx EDI detail line. Return strDocDetailTaxExID or ERROR
setEDIDocHeader EDI header. Return DocumentID or ERROR
setEDIDocHeaderAdvanced EDI header. Return DocumentID or ERROR
setEDIDocOtherCharge EDI detail line. Return DocumentDetailID or ERROR
setEDIDocOtherContent EDI Documents OTROS node: OtroContenido. Return CustomFieldValueID or ERROR
setEDIDocReference EDI Documents reference. Return DocumentID or ERROR
setEDIDocumentEDIStatus EDI Document EDI status. Return DocumentID or ERROR
setEDIDocumentInactive EDI Document blnInactive. Return DocumentID or ERROR
setEDIDocumentUser EDI Document user. Return DocumentID or ERROR
setEDIGetXML EDI: generate XMLDocument from DocumentType {INVOICE, TICKET, NCREDICT or NDEBIT} and DocKey. Return Base64String_XMLDocument or ERROR
setEDIGetXMLReception EDI: generate XMLDocument from RECEPTION and DocKey. Return Base64String_XMLDocument or ERROR
setEDIHeader_AditionalUpdate EDI Documents update. Return OK or ERROR
setEDINotifyAcknowledgment EDI: send notification to Transmitter. Return 'Sended' or ERROR
setEDINotifyDocument EDI: send notification to Receptor. Return 'Sended' or ERROR
setEDINotifyDocumentAdvanced EDI: send notification to Receptor. Return 'Sended' or ERROR
setEDIPortStatus Update EDIPort Status reference. Return DocumentID or ERROR
setEDIRecHeader_AditionalUpdate EDI Reception documents update. Return OK or ERROR
setEDISendSignedXML EDI: send Base64String_SignedXMLDocument to ATV. Return 'Accepted' or ERROR
setEDISignXML EDI: sign Base64String_XMLDocument. Return Base64String_SignedXMLDocument or ERROR
setExpedient Expedient: Add or update register. Return NULL or ERROR
setExpedientGroup Expedients set group: Add, update or delete register. Return strIDExpedient or ERROR
setKronosEmployee Emp: Add or edit. Return registry ID or ERROR
setKronosRule Rules: Add or edit. Return registry ID or ERROR
setLedgerAccount Vendors: Add or edit contact. Return registry ID or ERROR
setLedgerBankAccount Bank Account: Add or edit. Return registry ID or ERROR
setPaymentCondition Payment Condition: Add or edit. Return registry ID or ERROR
setPermitUser Permit user: Add, Update or delete register. Return OK or ERROR
setProductTax Product Taxt: Add, Update or delete register. Return strID or ERROR
setSequence Sequence: Add or edit. Return registry ID or ERROR
setSequenceDetail Sequence detail: Add or edit. Return registry ID or ERROR
setSequenceValue Sequence value: Add or edit. Return registry ID or ERROR
setSgAppRelated Sequence value: Add or edit. Return registry ID or ERROR
setStudent Expedient: Add or update register. Return NULL or ERROR
setSupplier Suppliers: Add or edit contact. Return registry ID or ERROR
setSupplierProductCategoryRelated Related contact: Add or delete register. strType={REL|RPV|CAT|PER} Return strIDContact or ERROR
setSupplierProductTypeRelated Related contact: Add or delete register. strType={REL|RPV|CAT|PER} Return strIDContact or ERROR
setTask Teamwork: Add/edit task. Return '[Guid]' (INSERT) or 'OK' (UPDATE)
setTaskAdvanced
Teamwork: Add/edit task. Return '[Guid]' (INSERT) or 'OK' (UPDATE)
setTaskContactRelated Teamwork: Add/Delete related contact from task. [intAction: 0=Add | 1=Delete
setTaskCustomFieldValue Teamwork Custon field: edit contact information. Return 'OK' or ERROR
setTaskCustomFieldValueCollection Teamwork Custon field: edit contact information. Return 'OK' or ERROR
setTaskNotify Teamwork: Notify task
setTaskStatus Teamwork: Add/edit task. Return '[Guid]' (INSERT) or 'OK' (UPDATE)
setTax Tax: Add or edit. Return registry ID or ERROR
setTeacher Teacher: Add or update register. Return NULL or ERROR
setType Utils: Add/Update/Delete types
setUploadFileToDB Utils: Upload file to database. Return registry ID or ERROR
setUploadFileToDBUTF8 Utils: Upload file to database. Return registry ID or ERROR
setUploadFileToPath Utils: Upload file to cloud. Return virtual file path or ERROR
setUploadFileToPathUTF8 Utils: Upload file to cloud. Return virtual file path or ERROR
validateAccountByLogin Verifica si el usuario vs contraseña son válidos. Returno: arrStrPerInfo('strPKPers','strName','strEmail','strPhone','strPKUser','strLogin','strPKCli','PKCli', 'strPerfil','PKPubliAc','FromName','FromEmail','strImagen','PKIdiomaN','strInitURL')
validateAccountByLogin Verifica si el usuario vs contraseña son válidos. Returno: arrStrPerInfo('strPKPers','strName','strEmail','strPhone','strPKUser','strLogin','strPKCli','PKCli', 'strPerfil','PKPubliAc','FromName','FromEmail','strImagen','PKIdiomaN','strInitURL')
validateAccountByLoginXML Verifica si el usuario vs contraseña son válidos
https://cloud.greyphillips.com/apis/soap/venom/communicator.asmx
Métodos Descripción
getDateTime Obtener la fecha/hora del servidor según el formato dado
getToken Security: Get access token. Return token or ERROR
setContactException Contacts: Add or update contact exception. Return NULL or ERROR
setMessage Communicator: Send sms, email or whatsapp message sender. Return registry IDMessage or ERROR
setPushNotificationToID Communicator: Send Firebase Cloud Messages. Return registry IDMessage or ERROR
setUploadFileToDB Utils: Upload file to database. Return registry ID or ERROR
setUploadFileToPath Utils: Upload file to cloud. Return virtual file path or ERROR

Ejemplos de código fuente

¿Desconoce cómo usar nuestros Web Service? No se preocupe gastando tiempo en investigar cómo hacerlo, nosotros ponemos a su disposición ejemplos de códigos fuente en diversos lenguajes de programación para facilitar dicho proceso.

Saber mas...

Contacts

Teamwork

Agenda

DoX

Expedients

Media

Retail

Marketplace

Pesado y Etiq.

Kronos

EDI

Klass