Obtener información sobre suscripciones desde un sitio web mediante la API

Acceso necesario: Analytics y token API
Dificultad: Sólo para desarrolladores

Este artículo está dirigido a los desarrolladores que deseen incorporar información de otro sistema a Borealis. Da ejemplos de cómo:

Obtener los valores posibles para un menú desplegable
Crear un nuevo registro para una parte interesada
Crear una comunicación vinculada a la parte interesada que se acaba de crear

Un buen ejemplo de esto es si usted tiene un sitio web donde las partes interesadas pueden ingresar su información para suscribirse a su boletín de noticias, o una sección de retroalimentación donde las partes interesadas pueden hacer preguntas o dar comentarios. En ambos casos, usted desea enviar la información de este formulario a Borealis.

Antes de empezar

Asegúrese de que dispone de un token de API válido. Este debe ser proporcionado por su superusuario.
Puede encontrar la documentación del API en esta dirección: https://COMPANY.boreal-is.com/api-docs/YOUR_INSTANCE/
- Nota: Si está NO utilizando un paquete corporativo, los valores para COMPANY y YOUR_INSTANCE deberán ser los mismos.

Obtenga los valores posibles de un listado desplegable.

Gran cantidad de campos en Borealis son menús desplegables. Por ejemplo, un registro necesita estar vinculado a un Proyecto (a veces llamado Derechos de acceso). Para acceder a la lista de valores posibles, puede realizar una llamada como ésta:

Llamada

curl -X GET "https://COMPANY.boreal-is.com/api/v2/YOUR_INSTANCE/stakeholders_engagement~register~individuals/values/stkProjectMulti?limit=10&offset=0" -H "accept: application/json" -H "api_key: YOUR_API_TOKEN"

Respuesta

{"total":3,"data":[{"displayValue":"Mine site","value":1},{"displayValue":"Transmission line","value":2},{"displayValue":"General","value":3}
  ]
}

Puede elegir el valor que desea añadir. El valor no cambiará con el tiempo, por lo que puede configurarlo inicialmente y no preocuparse más tarde.

Crear un nuevo registro de individuo

A continuación mostramos un ejemplo de cómo crear un nuevo registro para el individuo "Ms. Jane Doe".

Puede encontrar la documentación de API para la administración de individuos aquí: https://COMPANY.boreal-is.com/apidocs/YOUR_INSTANCE/stakeholders_engagement

~register~individuals/

La creación de un nuevo registro es una llamada POST con el siguiente cuerpo:

{
  "baseCatIndividualTtlId": 7,
  "firstName": "Jane",
  "lastName": "Doe",
  "stkProjectMulti": [3],
  "onAddEmail": jane.doe@invalidemail.test,
  "onAddPhonenumber": "01 22 22 22 22",
  "onAddAddress": "1 Salmon Street",
  "onAddCity": "Magog",
  "onAddStateProvince": "Quebec",
  "onAddCountry": "Canada",
  "onAddPostcode": "J1X 1G8”
}

Hemos utilizado baseCatIndividualTtlId = 7 ya en que este caso este es el valor para "Ms.".

Puede encontrar muchas otros campos que pueden ser llenados en la documentación del API.

Respuesta

{
 "sysId": 33842
}

Puede usarlo para la llamada de creación de una comunicación.

Crear una comunicación

Aquí tiene un ejemplo para la creación de una comunicación de retroalimentación en la que Ms. Jane Doe hace una pregunta:

Puede entontrar la información sobre la administración de comunicaciones en la documentación de API: https://COMPANY.boreal-is.com/apidocs/YOUR_INSTANCE/stakeholders_engagement~

consultations~communications/

Crear un nuevo registro es una llamada de tipo POST con el siguiente cuerpo:

{
 "stkMtSummaryNoHl": "I wanted to know if the street will still be closed next week-end. Please send me an email to confirm.",
 "importCommunicationDate": "2021-11-18",
 "baseStakeholderId": [33842],
 "stkMtTitle": "Question from the website",
 "baseProjectId": [3],
 "stkCatMeetingTypeId": 63
}

Hemos usado stkCatMeetingTypeId = 63 porque en nuestro caso este corresponde al valor "preguntas".

Puede encontrar muchos otros campos que pueden ser completados usando la documentación del API. La respuesta le dará el número de ID de la comunicación creada.

Añada una parte interesada a una lista de distribución

Si desea añadir una parte interesada a una lista de distribución, debe crear antes la lista de distribución y buscar su identificador.

El identificador del sistema puede deducirse del Ref. no. Por ejemplo un Ref. no DL-00019 significa que el identificador del sistema es 19.

Crear un nuevo registro es una llamada POST con el siguiente URL (en este ejemplo el identificador del sistema para la lista de distribución es 19):

https://COMPANY.boreal-is.com/api/v2/YOUR_INSTANCE/stakeholders_engagement~stk_administration_tools~distribution_lists/19/stakeholders

y el cuerpo siguiente:

{
 "baseStakeholderIdAdd": [33842]
}

Crear una Contribución a la Comunidad (Inversión Social)

He aquí un ejemplo para crear una solicitud de patrocinio enviada a través de un formulario web.

Puede encontrar la documentación de la API para gestionar las contribuciones de la comunidad aquí:

https://COMPANY.boreal-is.com/apidocs/YOUR_INSTANCE/social_investment~investment_portfolio

~community_contribution/

Crear un nuevo registro es una llamada POST con el siguiente cuerpo:

{
"title": "Sponsorship request",
"receptionDate": "2023-01-16",
"contributionContext": "Part of the program to improve the activity options at the school",
"followUpContact": 33842,
"contributionType": 3,
"requestedItemDescription": "Monetary contribution",
"siCatContribItemTypeId": 1,
"requestedItemValue": 5000,
"responsiblePerson": 11
}

Hemos usado:

contributionType= 3 por que en este caso 3 es para "Patrocinio"
siCatContribItemTypeId = 1 porque este es para el valor monetario
responsiblePerson = 11 porque este numero representa a "Adam Paige", la persona responsable de revisar las solicitudes de patrocinios.

Encontrara un listado de otros campos que pueden ser llenados en la documentación del API. La respuesta proporcionará el número de identificación del sistema (ID) del registro de contribución a la comunidad creado.

Lo anterior cubre los elementos básicos de como realizar las llamadas necesarias en el API de Borealis para integrar información proveniente de un sitio web. Puede encontrar más información general sobre el uso del API en el siguiente artículo. También puede visitar el siguiente ejemplo sobre como integrar información de Borealis en otro sistema.

Artículos relacionados