Alertas y monitorización de empresas

1. Introducción

En este mini-tutorial te enseñamos a utilizar el servicio de Alertas con el que recibirás un e-mail cada vez que una empresa de tu elección aparezca en uno de los Boletines Oficiales soportados. Además también puedes consultar las últimas alertas mediante API.

Al finalizar tendremos importada una lista de empresas que queremos seguir y sabrás consultar los últimos cambios.

2. Obtención de credenciales

Lo primero que tenemos que hacer es obtener las credenciales de acceso. Estas se encuentran en tu Panel de Usuario en la sección API > Credenciales.

Anota tu nombre de usuario y contraseña una vez los tengas localizados.

3. Añadir empresas a tu lista de seguimiento

Lo primero que debemos hacer es añadir una empresa a nuestra lista de seguimiento. Hay dos formas de hacerlo:

1. Localizando la empresa mediante el buscador web y pulsando en el botón Seguir
2. Usando el endpoint específico de la API para dicha tarea

En este ejemplo vamos a añadir mediante API la empresa AENA S.M.E. SA, para la cual sabemos que el NIF es A86212420. Si desconoces el NIF también puedes añadirla mediante su slug.

curl -X POST -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/follow/ -d nif=A86212420 -d type=company

Si has hecho correctamente la petición el resultado será:

{"result": "success"}

4. Consultar las últimas alertas

La llamada al siguiente endpoint nos devolverá las últimas alertas que se hayan registrado:

curl -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/

Como aún no se ha producido ningún evento desde que has añadido la empresa, la respuesta será la siguiente:

[]

Si en cambio se ha producido algún evento, la respuesta será similar a esta:

[
  {
    "id": "a68af8de-2544-46b3-9e43-d9bcaa4adf23",
    "created_at": "2024-02-19T16:40:05.046Z",
    "data": [
      {
        "borme": {
          "cve": "BORME-A-2024-27-28",
          "url": "https://www.boe.es/borme/dias/2024/02/07/pdfs/BORME-A-2024-27-28.pdf",
          "date": "2024-02-07",
          "province": "Madrid"
        },
        "label": "Revocaciones",
        "company": {
          "name": "AENA S.M.E. SA",
          "slug": "aena-s-m-e"
        },
        "positions": [
          {
            "role": "Apo.Sol.",
            "type": "Person",
            "name_person": "MONJE GARCIA EUGENIO",
            "slug_person": "monje-garcia-eugenio"
          }
        ],
        "announcement": {
          "date": "2024-01-31",
          "year": 2024,
          "branch": "",
          "number": 65213,
          "office": "",
          "registry_data": "T 39608 , F 186, S 8, H M 518648, I/A 362"
        },
        "total_positions": 1
      },
      {
        "borme": {
          "cve": "BORME-A-2024-27-28",
          "url": "https://www.boe.es/borme/dias/2024/02/07/pdfs/BORME-A-2024-27-28.pdf",
          "date": "2024-02-07",
          "province": "Madrid"
        },
        "label": "Nombramientos",
        "company": {
          "name": "AENA S.M.E. SA",
          "slug": "aena-s-m-e"
        },
        "positions": [
          {
            "role": "Apoderado",
            "type": "Person",
            "name_person": "DE LA HERA RETUERTO CARMEN-ROSA",
            "slug_person": "de-la-hera-retuerto-carmen-rosa"
          }
        ],
        "announcement": {
          "date": "2024-01-31",
          "year": 2024,
          "branch": "",
          "number": 65213,
          "office": "",
          "registry_data": "T 39608 , F 186, S 8, H M 518648, I/A 362"
        },
        "total_positions": 1
      }
    ],
    "seen_at": "2024-02-19T16:40:05.035Z",
    "entity_name": "AENA S.M.E. SA",
    "entity_slug": "aena-s-m-e",
    "entity_type": "company"
  }
]

5. Marcar las alertas como leídas

curl -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/mark_as_read/a68af8de-2544-46b3-9e43-d9bcaa4adf23/

{"result": "success"}

Marcar todas como leídas

curl -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/mark_as_read/all/

{"result": "success"}

curl -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/

[]

6. Consultar lista de seguimiento

Puedes consultar en todo momento las empresas que estás siguiendo mediante la siguiente llamada:

curl -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/following/

{
  "entities": [
    {
      "type": "company",
      "name": "AENA S.M.E. SA",
      "slug": "aena-s-m-e",
      "nif": "A86212420",
      "added_at": "2024-02-19 16:40:05+01:00"
    }
  ]
}

7. Dejar de seguir una empresa

curl -X POST -u $API_USER:$API_TOKEN https://api.librebor.me/v2/alerts/unfollow/ -d nif=A86212420 -d type=company

{"result": "success"}