Gobierno de España. Ministerio de Hacienda y Función Pública. Abre nueva ventana
Administración Presupuestaria

Preguntes freqüents sobre l'API

Preguntes freqüents sobre els serveis electrònics d'intercanvi d'informació relativa al Pla de Recuperació, Transformació i Resiliència.

Informació Preliminar

Disponibilitat de l'API

Connexió i ús del servei

Preguntes generals sobre l'API

Informació preliminar

Què és CoFFEE i CoFFEE-MRR?

CoFFEE (Plataforma Comuna de Fons Europeus) és la plataforma informàtica comuna per a la gestió de fons europeus. Està orientada a integrar els diversos mòduls que donen suport a la gestió dels fons europeus competència de la Secretaria General de Fons Europeus (SGFE) en el marc financer plurianual 2021-2027 (MFP 21-27). És l'evolució dels sistemes d'informació que donen suport a la gestió del Fons Europeu de Desenvolupament Regional (FEDER) en els marcs financers previs al 2021-2027, però ha estat concebuda per albergar el suport a altres fons i/o mecanismes.
CoFFEE-MRR és un mòdul de CoFFEE que aprofita la tecnologia, els processos transversals, els mecanismes d'incorporació de la informació, etc. de la plataforma, i que incorpora la funcionalitat necessària per a la planificació, la gestió i el seguiment de les iniciatives associades al Mecanisme de Recuperació i Resiliència, i en concret al Pla de Recuperació, Transformació i Resiliència (PRTR).

Com sol·licito l'accés a CoFFEE/CoFFEE-MRR?

El procediment per sol·licitar l'accés als sistemes de l'Administració Pressupostària està descrit en la secció “Control d'Accessos” del Portal d'Administració Pressupostària.

Disponibilitat de l'API

Para què serveix l'API de CoFFEE?

Els serveis electrònics es posen en funcionament per facilitar a les entitats executores de les iniciatives donar compliment a l'establert en la normativa que regula el Pla, i en particular en l'Ordre HFP/1030/2021, de 29 de setembre, per la qual es configura el sistema de gestió del Pla de Recuperació, Transformació i Resiliència (Ordre de Gestió), i l'Ordre HFP/1031/2021, de 29 de setembre, per la qual s'estableix el procediment i format de la informació a proporcionar per les Entitats del Sector Públic Estatal, Autonòmic i Local per al seguiment del compliment de fites i objectius i d'execució pressupostària i comptable de les mesures dels components del Pla de Recuperació, Transformació i Resiliència (Ordre d'Intercanvi), i està dirigida a les entitats que disposin de capacitat i recursos per connectar els seus propis sistemes de gestió amb CoFFEE per proporcionar la informació requerida.
Les entitats que no disposessin d'aquesta capacitat poden incorporar la informació de forma interactiva, per a això prèviament han de sol·licitar l'accés.

Està l'API REST ja disponible per connectar-me?

La disponibilitat de l'API es mostra a l'espai de “Formats d'intercanvi” de CoFFEE al Catàleg de Sistemes d'Informació.

Quin és l'última versió disponible?

Les diferents versions i el seu estat es troben disponibles a l'espai de“Formats d'intercanvi” de CoFFEE al Catàleg de Sistemes d'Informació.

Hi ha mecanismes alternatius a l'API per proporcionar informació a la plataforma?

Sí, depenent del tipus d'informació a reportar, el sistema proporcionarà mecanismes perquè la informació es proporcioni de forma interactiva pels usuaris que es connectin a ell, i també mitjançant la incorporació (interactiva) d'un arxiu amb totes les dades a tractar.
Naturalment, CoFFEE realitzarà les mateixes validacions quan es proporcioni la informació de forma massiva a través de la càrrega d'un fitxer.

Quin és el format de codificació del fitxer JSON que es carrega en CoFFEE?

La codificació és UTF-8.

Connexió i ús del servei

Com sol·licito l'accés a l'API i quin procediment desencadena?

Es pot sol·licitar l'accés a l'API a través de l'opció “Sol·licitar aquest servei web” del servei web “CoFFEE-MRR Servei d'Intercanvi” al Catàleg de Serveis Web del Portal d'Administració Pressupostària, a partir del moment en què s'anunciï que el servei està disponible.
El procediment es pot resumir en aquests punts:
1.     El responsable del sistema que va a integrar-se amb CoFFEE sol·licita l'accés; durant el procés es concreta el certificat electrònic que s'usarà per a la comunicació segura/segura.
2.     Un responsable funcional de CoFFEE en la Secretaria General de Fons Europeus (SGFE), després de verificar la legitimitat del sol·licitant, aprova l'autorització.
3.     Els serveis tècnics de l'Oficina d'Informàtica Pressupostària assignen un codi de “usuari de servei”. En col·laboració amb la SGFE, s'assigna dins de CoFFEE un perfil d'accés per a dita usuària de servei, la qual cosa determina l'àmbit d'informació sobre la qual podrà treballar a través de l'intercanvi electrònic.
4.     Es proporciona al contacte tècnic del sistema que es vol integrar amb CoFFEE el codi de l'usuari del servei (denominat “idUsuario”), a més d'un codi identificatiu del propi servei (“idAplicacion”), que haurà de conservar per al seu ús en les invocacions al servei.
 

Com s'aconsegueix la seguretat en l'accés?

Els serveis Web client s'autenticaran mitjançant HTTPS/TLS (1.2 o superior). En concret, s'utilitzarà un certificat de segell d'Administració, òrgan o entitat de dret públic per a actuació administrativa automatitzada, o un certificat de segell electrònic qualificat derivat del Reglament eIDAS, emès en qualsevol cas per algun dels prestadors de serveis de certificació reconeguts pel servei @Signa.

Durant el procés organitzatiu d'autorització d'accés s'acorda entre l'Oficina d'Informàtica Pressupostària i el contacte tècnic de l'organisme interessat el certificat que utilitzarà l'extrem client del servei.

¿Com és una interacció típica amb el servei (una trucada a un mètode de l'API)?

Una vegada ha finalitzat el procés d'autorització de l'accés, el sistema client està en condicions de fer ús del servei. Per a això, tota interacció es durà a terme sota una comunicació segura/segura (TLS) utilitzant el certificat de segell preacordado.
Cada trucada al servei REST inclourà en la petició HTTP, a més dels paràmetres indicats en la documentació del propi servei, dos paràmetres addicionals (idUsuario i idAplicacion), que contindran els valors que es van facilitar durant el procés de configuració de l'accés.

¿Poden diverses organitzacions utilitzar el mateix certificat de segell per interactuar amb l'API?

Encara que no és habitual, aquesta possibilitat s'habilita si es tramiten dues sol·licituds d'accés, una per cadascuna de les organitzacions, i es configura el mateix certificat en ambdues. En el procés d'autorització es crearà i assignarà un usuari de servei (idUsuario) diferent per a cadascuna d'elles, i es configuraran en CoFFEE els corresponents perfils que actuïn en cadascun dels àmbits.
Atès que cada petició al servei inclou entre els seus paràmetres el codi d'usuari de servei (idUsuario), CoFFEE podrà determinar l'origen i podrà actuar en conseqüència, aplicant el perfil de seguretat corresponent.
No obstant l'anterior, cal tenir en compte que si una de les organitzacions utilitzés el idUsuario assignat a l'altra, no existiria cap mecanisme per identificar la suplantació, per la qual cosa aquesta possibilitat es durà a terme a risc de les organitzacions client.

Hi ha límits establerts per a l'ús del servei?

S'han definit els següents límits:
  • Grandària màxima de petició: 100MB.
  • Grandària màxima de document: 60MB.
  • Límit màxim d'elements en una col·lecció: 100 elements.
  • Nombre de peticions per minut: pendent d'establir.

Preguntes generals sobre l'API

Quin és el format de les dates?

Se segueix l'especificació OpenApi 3.0 que fa referència a la definició RFC 3339, sección 5.6, per exemple 2022-07-21.
Es importante destacar que algunas fechas solicitadas se deben especificar en trimestres.

Són tots els camps de l'API obligatoris?

No, només són obligatoris aquells camps que estan marcats com a tals (amb un asterisc en vermell).

Puc enviar múltiples declaracions d'execució comptable en la mateixa trucada POST?

Sí, cada trucada pot contenir quantes declaracions es desitgin del mateix declarant (un únic declarant), com ve especificat en el tipus de dades “DeclaracionEjecucion” de l'esquema.

En relació a les declaracions de progrés d'indicadors: el camp “data” (la data de referència del progrés), ha de ser la data actual?

La data de referència del progrés d'un indicador és aquella en què es considera aconseguit el valor de l'indicador que s'actualitza, i per tant ha de ser anterior o igual a la data actual, és a dir, no es permeten dates futures.

Què és la referència d'un instrument jurídic?

A les declaracions d'execució comptable s'especifica una referència de l'instrument jurídic sota el qual es fa la declaració. El cas típic és un contracte o una subvenció, però tots els instruments previstos han de poder ser identificats.
La referència és, per tant, un codi que identifica a l'instrument jurídic concret en l'àmbit de l'Actuació per la qual es registra l'execució.
Habitualment la referència coincideix amb el propi codi de l'instrument que estableix la persona que ho dona de alta/dóna de alta en CoFFEE (ben sigui per pantalla, càrrega massiva, ...).
Per exemple, en el cas d'una subvenció donada de alta en CoFFEE amb el codi BDNS "576282", la referència és exactament aquest mateix codi. O un contracte (no PLACSP) que s'ha donat de alta en CoFFEE amb el codi de contracte "2023OIP45544", tindrà aquest mateix codi com a referència.
No obstant això, hi ha un cas més complex que és el dels contractes PLACSP, i que es tracta específicament en la següent qüestió.

Com es diferencia un contracte que està donat de alta en la Plataforma de Contractació del Sector Públic (PLACSP) d'un que no ho està?

Els contractes PLACSP s'identifiquen per tres codis: codi d'òrgan de contractació, codi de licitació, i codi de contracte (veure següent qüestió per a una explicació detallada).
Els contractes No PLACSP s'identifiquen mitjançant un únic codi.
En les entrades d'alta de contractes en CoFFEE, els dos tipus de contracte s'identifiquen de forma separada.
Atès que les referències d'instruments jurídics es fan a través d'un únic camp, en el cas de contractes PLACSP (que, com s'ha indicat, tenen tres codis) la referència correspon a la concatenació dels tres valors utilitzant el separador “” entre ells, fins i tot encara que els camps estiguessin buits.

Què són els codis òrgan de contractació, de licitació i de contracte de PLACSP?

El codi de l'òrgan de contractació és un identificador que usa la Plataforma de Contractació del Sector Públic (PLACSP) associat a cadascun dels òrgans (en PLACSP es denomina “ANEU Plataforma”). Cada òrgan de contractació pot consultar el seu propi en la pantalla d'administrador del perfil “administrador de l'òrgan de contractació” de PLACSP.
PLACSP1.PNG
A més, la Direcció general de Patrimoni de l'Estat publica periòdicament la relació de codis en unafulla Excel que van actualitzant.
En el cas de PLACSP i per a cada òrgan de contractació, els codis de licitació i de contracte són els que identifiquen de forma única un contracte que s'incorpora a la Plataforma de Contractes del Sector Públic:
El codi de licitació es correspon amb el Nombre d'Expedient en la PLACSP, que és el nombre d'expedient que proporciona cada òrgan de contractació.
El codi de contracte correspon amb el Contracte de la PLACSP. És també un valor que determina l'òrgan de contractació. Correspon a cada contracte dins de l'expedient.
En qualsevol cas, tots dos són valors que proporciona el gestor a la PLACSP.PLACSP1.PNG

Quan s'emplena el camp “Altres Fonts de finançament”?

La informació sobre altres fonts d'informació s'emplenarà quan l'actuació a la qual correspon l'operació estigui finançada per alguna altra font, de manera addicional al finançament amb càrrec al Mecanisme de Recuperació i Resiliència. En aquest cas, s'identificarà el mecanisme o fons que ha finançat l'operació.
 

Per al cas d'enviament d'informació comptable: han d'estar donats de alta en CoFFEE prèviament a la remissió d'informació els contractes/subvencionis que s'incloguin?

Sí, és necessari que els tercers estiguin donats de alta en CoFFEE prèviament a la remissió de la informació comptable. L'API proporciona els serveis necessaris

En el cas d'enviament d'informació comptable, han d'estar donats de alta en CoFFEE prèviament a la remissió d'informació els tercers (beneficiaris, contractistes, etc.) que s'incloguin?

Sí, és necessari que els tercers estiguin donats de alta en CoFFEE prèviament a la remissió de la informació comptable. L'API proporciona els serveis necessaris

En el cas de fases comptables “barrades” (A/, D/, O/, AD/, ADO/, PR/, RE/), els imports s'han de reflectir en positiu o en negatiu?

Els imports en documents barrats són sempre positius; la barra ja indica que els imports es tractaran comptablement en negatiu.

Una vegada enviada la informació d'execució comptable o de progrés d'indicadors: Rebré algun justificant de recepció?

Sí, el sistema proporcionarà un justificant de recepció electrònic que permeti la traçabilitat de les operacions.

Canvis destacats de v1.3.1 a v1.5

Es llisten els canvis destacats segons el tipus de dades:
  • Tots els tipus:
    • codigoIniciativa és ara codigoActuacion
  • Mesura:
    • fechaInicio el seu valor és un trimestre
    • fechaFin el seu valor és un trimestre
  • Contracto:
    • contratoPLACSP és ara codigoInstrumento, codigoLicitacion i codigoOrgano
    • contratoNoPLACSP és ara codigoInstrumento
  • Subvencion:
    • convocatoriaBDNS és ara codigoInstrumento
  • Iniciativa:
    • Separada en Projecte, Subprojecte, SubproyectoInstrumental i Actuacion.
    • fechaInicio el seu valor és un trimestre
    • fechaFin el seu valor és un trimestre
  • DeclaracionFinanciera
  • DeclaracionProgresoIndicador
    • codigoIniciativa ara es diu codigoOrigenProgreso
Per norma general, els camps desapareguts no és necessari informar-los.

Canvis destacats de v1.5.0 a v1.5.1

  • Ruta:
    • S'ha actualitzat la ruta POST /ejecucion/altres-instruments/destinataris
    • SS'han actualitzat les rutes de detall d'un instrument jurídic. El paràmetre {referencia} es converteix en paràmetre de query. Per exemple, GET /estructura/actuacions/{codigo}/convenis/{referencia} es converteix en GET /estructura/actuacions/{codigo}/convenis/detalli?referencia={referència}
  • Actuacion:
    • S'ha actualitzat el camp transferenciaDeRecursosEconomicosAOtroSubproyecto de Actuacion, es converteix en opcional.
    • S'ha afegit el camp hitosObjetivosCriticos a Actuacion.
    • S'ha actualitzat el tipus del camp recursosEconomicos de Actución.
  • Subprojecte:
    • S'ha eliminat el camp costeEstimado de recursosEconomicos de Subprojecte.
  • SubproyectoInstrumental:
    • S'ha eliminat el camp costeEstimado de recursosEconomicos de SubproyectoInstrumental.

Canvis destacats de v1.5.1 a v1.5.2

  • codigoPropietario El paràmetre codigoPropietario passa a ser opcional en les següents rutes:
    • /v1.5/estructura/proyectos
    • /v1.5/estructura/subproyectos
    • /v1.5/estructura/subproyectos-instrumentales
    • /v1.5/estructura/actuaciones
    Si no va inclòs, la llista contindrà tots els elements del tipus corresponent als quals l'usuari tingui accés.
  • projecto Els subprojectes, subprojectes instrumentals i actuacions inclouen un resum del projecte al que pertanyen (propietatprojecto).

Preguntes generals sobre l'API v2.0

Com obtinc el codi únic d'un instrument jurídic?

El codi únic d'un instrument jurídic s'obté de tres formes:
  • Alta d'instrument jurídic: en la resposta de l'operació d'alta es retorna el codi únic assignat a l'instrument jurídic. Per exemple: POST /v2.0/contractes
  • Consulta d'instruments jurídics d'una actuació: el llistat d'instruments jurídics inclou el codi únic de cada instrument jurídic. GET /v2.0/actuacions/{codigo}/instruments-juridicos
  • Consulta de codi únic: existeix una utilitat per obtenir el codi únic d'un instrument jurídic a partir del codi d'actuació i la referència de l'instrument jurídic. GET /v2.0/instruments-juridicos/utilitats/codigo-unico

Com es realitza la pujada de documents?

La pujada de documents consta de dos passos:
  • Pujada del document: S'afegeix un document nou al sistema i s'obté el localitzador necessari per a altres operacions. El document es crea amb el tipus PENDENT. Els documents pujats i no associats a un element seran esborrats periòdicament. El servei utilitzat és: POST /v2.0/documents
  • Associació del document amb un element:: El document pujat en el punt anterior s'associa a un element. En l'associació s'indica el localitzar el document, el tipus efectiu i les metadades addicionals. El servei utilitzat depèn de l'element, per exemple, per afegir un document a un contracte, el servei és: POST /v2.0/contractes/{codigo-unico}/documents
Si es desitja associar el mateix document a diversos elements, solament és necessari realitzar una vegada la pujada del document podent utilitzar el localitzador tantes vegades com sigui necessari.

Altres dubtes

Tinc dubtes funcionals sobre la gestió del Pla de Recuperació Transformació i Resiliència i el sistema de gestió del mateix, on puc dirigir-me?

La descripció del funcionament del Pla s'articula amb dos Ordres Ministerials:
  • Ordre HFP/1030/2021, de 29 de setembre, per la qual es configura el sistema de gestió del Pla de Recuperació, Transformació i Resiliència.
  • Ordre HFP/1031/2021, de 29 de setembre, per la qual s'estableix el procediment i format de la informació a proporcionar per les Entitats del Sector Públic Estatal, Autonòmic i Local per al seguiment del compliment de fites i objectius i d'execució pressupostària i comptable de les mesures dels components del Pla de Recuperació, Transformació i Resiliència.

Tinc més dubtes tècnics relacionades amb l'API, on puc dirigir-me?

Per a la resta de dubtes tècnics sobre l'API REST de CoFFEE, es pot escriure un missatge a l'adreça de correu electrònic de suport CoFFEE-Desarrollo@igae.hacienda.gob.es
Des d'aquesta bústia s'atendran exclusivament consultes de caràcter tècnic referides a l'intercanvi d'informació amb la plataforma.