El acceso a la API de cristal se hace vía la habilitación de token a usuarios externos.
Para crear los token es necesario crear un usuario con derechos de acceso externo para una cuenta y con ese token se puede tener acceso a las distintas acciones documentadas en la API.
Es importante tener en cuenta que un token es único por id de cuenta asociado, por ejemplo si un usuario tiene el atributo CLIENTE con acceso a 3 números de cuenta (125/12/7840) los token serán por cada una de las cuentas asociadas no por el usuario para todas las cuentas¡ATENCION! Si usted no tiene conocimientos técnicos es recomendable que empiece a leer este documento desde "Preguntas y Respuestas para Usuarios No Avanzados"
La combinación Usuario >-> Atributos <->> cuentas <-> token
O sea que un usuario puede tener un único atributo, cada atributo N cuentas y cada cuenta un solo token.
La documentación técnica para el uso de la API la podemos encontrar en Api´s de Cristal
Información técnica
La API está desarrollada para acceder mediante tokens de acceso únicos por atributo (usuario, cliente, proveedor, etc) de modo que el token limita el acceso al atributo asociado a él.
Toda la información se opera por envío de parámetros GET y POST dependiendo el parámetro, respetando tipos.
Los objetos se envían siempre en formato JSON.
Las respuestas son del tipo JSON con los siguientes datos mínimos:
- sts: Devuelve 0/1 dependiendo si la respuesta es OK o un error
- error: Mensaje del error en caso de existir
- msg: Mensaje adicional en caso de corresponder u OK en caso de no tener nada que informar.
Este objeto de retorno puede tener más información en caso de requerirlo como el viaje consultado, el estado actual de la carga, etc. Dependiendo de cada entrada.
La documentación técnica para el uso de la API la podemos encontrar en External API
Preguntas y Respuestas para usuarios No Avanzados
¿Para que me sirven las APIs ?
Una API es un conjunto de definiciones y protocolos que se utiliza para desarrollar e integrar los software entre sí.
API significa interfaz de programación de aplicaciones por sus siglas en inglés (Application Programming Interface). Las API permiten que sus productos y servicios se comuniquen con otros, sin necesidad de saber cómo están implementados.
¿Por qué necesitaría una API?
Simple, para "unirme" a cualquier cosa. ¿Que sería cualquier cosa? otro software que tengo en la empresa, un cliente, un proveedor, etc
También pueden usarse las APIs para informes específicos que se necesiten
¿O sea que las API sirven para "sacar" datos?
No. Las API pueden ser de entrada, de salida, para modificar, para actualizar hasta para cambiar un Password se puede usar una API, la usabilidad es infinita.
No entiendo ¿Cuál sería un ejemplo?
Es cierto que es medio difícil de entender, principalmente si no tenemos conocimientos técnicos, pero supongamos que por ejemplo yo hablo Castellano y quiero conversar con una persona que habla Holandés ¿Cómo haríamos? ¡Exacto! GoogleTranslator o por ejemplo un traductor humano. ¡Excelente! Eso es un API también, de carne y hueso pero una API.
Ahora dejando las metáforas, en la empresa, podemos explicar varios casos que voy a describir como operarían por API´s.
Tenemos un cliente que quiere saber el estado de la carga:
Disponemos de una entrada que recibe un número de seguimiento y responde con la trazabilidad completa de la carga ordenada cronológicamente.
Tenemos un cliente que nos quiere informar la carga para despachar:
Hay una entrada en la API que permite informar que se irá a despachar carga (podría ser para pedir un retiro también) con esto se puede recibir una Pre-Guia para despacho.
Necesito que un proveedor me avise los viajes que cumple que tercerizamos por él
Puede conectarse a una API que enviando el viaje la fecha y la hora reporte la novedad.
Necesito que dada una potencial carga decir cuanto sería el precio aproximado del envío
Esto se resuelve por API, con el detalle de la carga se puede estimar sobre la base de las tarifas del cliente.
¿Entonces cualquier cosa se puede hacer por API?
Casi cualquier cosa. Solo se pide y se agrega. Hay que tener en claro que se necesita hacer "quiero mostrar a un cliente la posición actual en un mapa de su carga" sería un ejemplo de como pedirlo
¿Y si quiero mandarle un resumen de cuenta de lo que debe?
Podría ser una API pero posiblemente para eso convenga una tarea automatizada por Correo Electrónico
¿Es muy caro agregar una API? ¿Se paga?
Como política los "token" tienen un precio pero las entradas a las API son gratuitas para clientes con Abono cuando insumen hasta 3 horas de producción. Para tener una idea, crear una consulta que devuelva un reporte simple insume 3 horas.
Agregar un proceso de generación de documentación como puede ser una Guía, un viaje un movimiento de stock posiblemente insuma unas 8/10 horas aproximadamente.
Desde luego que las tareas gratuitas son para tareas de caracter "normal" las solicitudes urgentes se tarifan como es habitual
¿Las interfases son APIs?
Muchas veces si, la mayoría. Es recomendable interfasear por API.
Este documento tiene el objetivo de ayudar entender como unir CRISTAL a cualquier software, solo tienen que pasar → " Este documento técnico ", al cliente o proveedor para que se lo envíen a su asesor de sistemas, posiblemente no lo entiendan ustedes si no son usuarios avanzados pero no importa.
Solo es recomendable que antes de pasarlo acuerden con su cliente o proveedor "que quieren conectar" que se quieren avisar entre los sistemas, si no tienen en claro entre las empresas que se quieren decir nada va a poder funcionar, si saben que se quieren mandar y qué quieren recibir todo es posible.
Desde DIGITAL EXPRESS podemos ajustar casi todas las necesidades que nos plantean nuestros clientes, si desde el otro software no es posible ajustar nada posiblemente no haya posibilidad de "unión".