Este instructivo tiene como objetivo facilitar las configuraciones iniciales para poder subir elementos a Deals.
¿Para qué sirve?
Este instructivo tiene como objetivo facilitar las configuraciones iniciales para poder publicar documentos vía API a Deals.
Antes de empezar
Configuraciones iniciales en el sistema.
Como precondición para poder llevar a cabo la publicación de Deals, se deben cumplir ciertas pautas:
- Contar con una empresa activa en Deals
Para validar esto, ingresar a Menú → Deals → Configurar Empresa.
Presionar en el botón “Activar”.
-
Contar con una configuración de integración directa de tipo POST para poder publicar en Deals, para cada documento que se quiera publicar.
-
Debe poseer un método GET, para cada documento que se quiera publicar, el cual se debe configurar, activando el check de webhook para vincular con el POST correspondiente:
- Escoger el punto de origen del método post.
- Configurar los parámetros con client id y secret key de GO.
- Estos campos se toman del usuario logueado:
Presionar sobre el usuario y luego presionar en modificar perfil
Solicitar el token de Deals
Una vez realizada la configuración correspondiente, es necesario realizar ciertas llamadas API para poder publicar en Deals.
- Solicitar un token
a) Para poder solicitar un token es necesario que nos dirijamos a la pantalla de configuración de empresa y tomemos los siguientes valores:
b) Dichos valores son necesarios para poder solicitar un bearer Token, para ello debemos realizar un POST al siguiente endpoint:
Ambiente Base URL
Dev https://go-dev.finneg.com/api/1/deals-back/authenticate
Qa https://go-qa.finneg.com/api/1/deals-back/authenticate
Prod https://go-prod.finneg.com/api/1/deals-back/authenticate
c) Con el siguiente formato de body
{
“cfu”: “4205948247241007559”,
“secretKey”:“$2a$10$gcboVvoCP6JRZdncWvBWFuszi31ax4LnZDGU2fNY3jIZQlfws5XiO”
}
d) Posteriormente, por Postman deberíamos recibir una respuesta similar a la siguiente
Modo de uso
Menú → Gestión Empresarial → Funcionalidad
Publicar documentos dentro de Deals
Para poder publicar sobre las APIs de Deals, además del endpoint, se debe tener en cuenta que se respeta una estructura puntual para poder publicar. Más particularmente, un doc de Deals se ve algo similar a:
[
{ "head":{ "CFUtoList":\[ "1213214321323" \], "externalIdentification":"SEL-BOL-2",“origin”: “codeOrigin”
}, "document":{}
]
- Atributo CFUtoList
El CFUtoList, se utiliza para enviar los diferentes receptores que nos interesa que reciban el documento, como en estos metodos post la idea es que lo reciban la misma empresa que se encuentra en el proceso de insertarlos en Deals.
- Atributo: externalIdentification
En él se recibe un string el cual es más que nada para tener una identificación de referencia pero posteriormente deals, no realiza ningún tipo de control sobre este campo.
- Atributo: origin
Deals lo utiliza para poder referenciar que método POST es el que se encuentra realizando la publicación. Dicho valor lo recibimos en el controlador como codeId, y proviene del code id que inicialmente configuramos el cual es visible desde el catálogo de documentos.