Referencias API

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.

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 SILVER 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
SILVER Versión del ACL, esta se puso a disposición de los usuarios a partir de Agosto del 2017
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, e incluso físicas, 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 gestión de otras aplicaciones de la plataforma que no forman parte de este documento y cualquier otra información funcional o información 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 de Costa Rica 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 Costa Rica, 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 ese dominio particular.

Usted como programador de la plataforma 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 de la base de datos para hacer la conexión con otra base de datos distinta.

La llave de identificación necesaria en todas las funcionales del ACL 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 utilizarse las funciones del ACL, usted debe de crear un usuario que quiera que sea el autorizado, para tal interconectividad, 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.

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.

Ver ejemplos

Métodos disponibles en las ACL:

Métodos Contacts Communicator Teamwork Agenda Dox Expedients Media Retail Marketplace Pesado y Etiq. Kronos Klass Seguridad EDI
getCatalogProdImgs X X
getCatalogProds X X
getCatalogProdStock X X
getContact
getContactAddress
getContactAdvanced
getContactCustomFieldValue
getDateTime X X X X X X X X X X X X
getDocData X X X
getEDIXMLfromATV X
getEDIXMLfromCloud X
getERPData X X X X X X X X X X X X
getGlobalContact X X X X X X X X X X
getGlobalContactDS X X X X X X X X X X
getSalesRanking X X
getTask
getTaskCustomFieldValue
getTaskCustomFieldValueXML
getToken X X X X X X X X X X X X X X
getUserAccess X
setContact X X X X X X X X X X X
setContactAddress
setContactAdvanced
setContactCustomFieldValue X X X X X X X X X X X
setContactException X X X X X X X X X X
setDocFileAttach X X X X X X X X X X
setEDIDocDetail X
setEDIDocDetailTax X
setEDIDocDetailTaxEx X
setEDIDocHeader X
setEDIGetXML X
setEDIGetXMLReception X
setEDINotifyAcknowledgment X
setEDINotifyDocument X
setEDISendSignedXML X
setEDISignXML X
setMessage X X X X X X X X X X
setTask X
setTaskContactRelated X X
setTaskCustomFieldValue X
setTaskNotify X
setUploadFileToDB X X X X X X X X X X X
setUploadFileToPath X X X X X X X X X X X
validateAccountByLogin X
validateAccountByLoginXML X

Contacts

Teamwork

Agenda

DoX

Expedients

Media

Retail

Marketplace

Pesado y Etiq.

Kronos

EDI

Klass