Todo acceso a la plataforma requiere ante todo la autenticación del usuario autorizado para realizar la conexión, este usuario deberá ser previamente establecido dentro de la PSI, de tal manera que cuando se haga la validación la plataforma sea capaz de validar que el usuario existe y tiene el perfil y los permisos suficientes para funcionar correctamente con el método seleccionado en cada caso.
Los ejemplos en este documento se refieren a una base de datos para pruebas, sin embargo, cada dominio en la plataforma, tiene un identificador único global y el usuario y contraseña están directamente ligados a este identificador, por lo que si el identificador del dominio cambia, el usuario y contraseña también deben ser considerados ya que estos están subordinados al dominio indicado.
Obtener un Token
Un token es un permiso temporal para acceder a la plataforma, cuyo tiempo de vida es de 5 minutos, durante ese tiempo el token puede ser usado múltiples veces, siempre y cuando el tiempo no haya sido superado, usualmente, la ejecución de un conjunto de métodos no requieren de un tiempo tan largo, por lo que el token se genera una vez y se utiliza repetidamente dentro de este marco de tiempo. Utilizar un token es un método estandarizado de la industria, que permite el ahorra de recursos valiosos de tiempo y sobrecarga de ejecución, ya que no es necesario validar una y otra vez la información de permisos y perfiles de los usuarios, al tiempo que simplifica los parámetros requeridos dentro de la ejecución de cada método.
Mas información relacionada al Web Service para obtener un token:
https://logica.cr/Developers/api_getToken.html
Para la correcta ejecución de este método regresara un valor, que será obligatorio para la ejecución de los métodos disponibles.
Así por ejemplo, si se desea registrar un contacto en la plataforma y su dirección, se usarían los siguientes métodos en este orden:
| Término | Descripción | Parámetros |
|---|---|---|
| GetToken | Obtiene el Token | Este método requiere del ID. Global, usuario y contraseña |
| SetContact | Registra el Contacto | Este método requiere el token y los datos del contacto |
| SetContactAddress | Registra la Dirección del Contacto | Este método requiere el token y el identificador del contacto |
Dependiendo del alcance de las aplicaciones que usen los servicios web, serán necesarios diferentes métodos, los métodos disponibles están referidos en este link:
https://logica.cr/Developers/API_Reference.html
Enviar y Recibir
Las funciones relacionadas a obtener información de la plataforma tienen el prefijo Get, así por ejemplo:
| Término | Descripción |
|---|---|
| getCatalogProds |
Se obtiene de la plataforma los productos disponibles para la venta |
| getCatalogProdImgs |
Se obtienen las imágenes relacionadas a los productos |
| getCatalogProdStock |
Se obtienen los inventarios disponibles para los productos. |
Las funciones relacionadas a enviar información hacia la plataforma tiene el prefijo Set, asi por ejemplo:
| Término | Descripción |
|---|---|
| setEDIDocHeader |
Crea el encabezado de una transacción electrónica (por ejemplo: Facturas electrónicas, Órdenes de Compra, etc.) |
| setEDIDocDetail |
Crea las líneas de detalle de la transacción electrónica |
| setEDIDocDetailTax |
Registra la información de impuestos relacionados a las líneas de detalle. |