Deals | Publicar documentos en Deals vía API — Acceso Directo

Deals
1

:timer_clock: Tiempo estimado: 15–30 minutos

¿Para qué sirve?

Permite enviar documentos a la plataforma Deals mediante llamadas a una API REST, utilizando una estructura JSON predeterminada. El envío puede realizarse desde cualquier sistema externo que soporte llamadas HTTP.

Antes de empezar

  • La empresa debe estar activa en Deals. Verificar en: Menú → Deals → Configurar Empresa → Activar. Ver: Configurar empresa
  • Contar con el Token de autenticación de Deals. Ver: Obtener token para publicar por API.
  • Tener el documento creado en el Catálogo de Documentos con su Schema definido.
  • Tener un método de Acceso Directo configurado en Publicaciones Propias.

Modo de uso

:round_pushpin: Menú → Deals → Catálogo de Documentos
:round_pushpin: Menú → Deals → Publicaciones → Publicaciones Propias

Paso 1 — Obtener el endpoint y el Schema del documento

  1. Ir a Deals → Catálogo de Documentos y seleccionar el documento a publicar.
  2. Copiar el valor del campo API para publicar — ese es el endpoint base del documento.
  3. Hacer clic en el botón Schema, cambiar a la vista Code y copiar la estructura JSON generada. Ese JSON es el valor que va dentro del atributo document en el body de la llamada.

Paso 2 — Configurar el método de publicación

Ir a Deals → Publicaciones → Publicaciones Propias → Crear Nuevo y completar los siguientes campos:

Campo Descripción
Nombre del Método Denominación funcional del flujo de publicación.
Control de Duplicados Al activarse, evita registros repetidos. Si el Schema tiene campos marcados como Clave Única, valida solo esos; de lo contrario evalúa la totalidad del JSON.
Informar duplicados en el monitor Registra las publicaciones rechazadas por duplicación en la grilla del monitor para su auditoría.
Código ID Identificador único del método dentro del espacio de trabajo de Deals. Se usa en el atributo origin de la llamada.

En la sección Acceso, seleccionar Directo. El tipo de visibilidad (público o privado) determina la estructura del endpoint y del campo origin (ver Paso 3).

Paso 3 — Realizar la publicación

URLs base por ambiente

La URL completa se forma concatenando la URL base del ambiente con el endpoint del documento obtenido en el Paso 1.

Ambiente URL base
Dev https://servicios-dev.finneg.com
QA https://servicios-qa.finneg.com
Prod https://go.finneg.com

Diferencias entre método público y privado

La estructura del endpoint y el valor del campo origin varían según el tipo de visibilidad configurado en el método:

Método privado Método público
Endpoint api/1/deals-back/terceros/<ESPACIO_DE_TRABAJO>/publicar/<NombreDelDocumento> api/1/deals-back/publicar<NombreDelDocumento>
Ejemplo api/1/deals-back/terceros/FINNEGANS/publicar/PedidoDeVenta api/1/deals-back/publicarPedidoDeVenta
Valor de origin "EDT_<ESPACIO_DE_TRABAJO><Codigo_ID>" "<Codigo_ID>"
Ejemplo de origin "EDT_FINNEGANS1234" "1234"

:backhand_index_pointing_right: El Código ID es el valor configurado en el campo homónimo del método (Paso 2) y es visible desde el Catálogo de Documentos.

Configuración de la llamada

  • Method: POST
  • Endpoint: <endpoint del documento según tipo>
  • Authorization: Bearer Token → valor del “Token” obtenido en el endpoint GET api/1/deals-back/info
  • Body: raw / JSON
Estructura del body

json

[
  {
    "head": {
      "CFUtoList": [
        "<CFU número>"
      ],
      "externalIdentification": "",
      "origin": "<valor según tipo de método — ver tabla arriba>"
    },
    "document": {
      "<schema del documento copiado del Catálogo>"
    }
  }
]

Los valores entre < > son marcadores de posición. Reemplazarlos por los valores reales antes de ejecutar la llamada.

Descripción de los atributos del body
Atributo Descripción
CFUtoList Lista de CFU (Clave Finnegans Única) de los receptores del documento. En publicaciones directas, se incluye la CFU de la misma empresa que realiza la publicación.
externalIdentification Identificador de referencia externo o código de trazabilidad provisto por el sistema origen. Se utiliza únicamente como dato informativo para auditoría y seguimiento. Deals no aplica validaciones, control de duplicidad ni lógica de negocio sobre este valor.
origin Identifica el método y el contexto desde el cual se realiza el envío. Su valor varía según si el método es público o privado (ver tabla de diferencias). Corresponde al Código ID configurado en el método de publicación.
document Estructura JSON que define la información que será interpretada y procesada por Deals. Corresponde al Schema del documento, obtenido desde Catálogo de Documentos → botón Schema → vista Code.

Qué hace y qué no hace

  • Hace: publica documentos en Deals mediante una llamada API REST con body JSON, tanto para métodos con acceso directo público como privado.
  • No hace: no valida ni controla el valor de externalIdentification. No procesa archivos PDF. Para publicaciones con PDF e IA, ver el artículo PDF con IA por API.
Deals | Obtener token de autenticación para publicar en Deals vía API