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

Preguntas frecuentes sobre o API

Preguntas frecuentes sobre os servizos electrónicos de intercambio de información relativa ao Plan de Recuperación, Transformación e Resiliencia.

Información Preliminar

Dispoñibilidade do API

Conexión e uso do servizo

Preguntas xerais sobre o API

Información preliminar

Que é CoFFEE e CoFFEE-MRR?

CoFFEE (Plataforma Común de Fondos Europeos) é a plataforma informática común para a xestión de fondos europeos. Está orientada a integrar os diversos módulos que dan soporte á xestión dos fondos europeos competencia da Secretaría Xeral de Fondos Europeos (SGFE) no marco financeiro plurianual 2021-2027 (MFP 21-27). É a evolución dos sistemas de información que dan soporte á xestión do Fondo Europeo de Desenvolvemento Rexional (FEDER) nos marcos financeiros previos ao 2021-2027, pero foi concibida para albergar o soporte a outros fondos e/ou mecanismos.
CoFFEE-MRR é un módulo de CoFFEE que aproveita a tecnoloxía, os procesos transversais, os mecanismos de incorporación da información, etc. da plataforma, e que incorpora a funcionalidade necesaria para a planificación, a xestión e o seguimento das iniciativas asociadas ao Mecanismo de Recuperación e Resiliencia, e en concreto ao Plan de Recuperación, Transformación e Resiliencia (PRTR).

Como solicito o acceso a CoFFEE/CoFFEE-MRR?

O procedemento para solicitar o acceso aos sistemas da Administración Orzamentaria está descrito na sección “Control de Accesos” do Portal de Administración Orzamentaria.

Dispoñibilidade do API

Para que serve o API de CoFFEE?

Os servizos electrónicos ponse en funcionamento para facilitar ás entidades executoras das iniciativas dar cumprimento ao establecido na normativa que regula o Plan, e en particular na Orde HFP/1030/2021, do 29 de setembro, pola que se configura o sistema de xestión do Plan de Recuperación, Transformación e Resiliencia (Orde de Xestión), e a Orde HFP/1031/2021, do 29 de setembro, pola que se establece o procedemento e formato da información a proporcionar polas Entidades do Sector Público Estatal, Autonómico e Local para o seguimento do cumprimento de fitos e obxectivos e de execución orzamentaria e contable das medidas dos compoñentes do Plan de Recuperación, Transformación e Resiliencia (Orde de Intercambio), e está dirixida ás entidades que dispoñan de capacidade e recursos para conectar os seus propios sistemas de xestión con CoFFEE para proporcionar a información requirida.
As entidades que non dispuxesen desa capacidade poden incorporar a información de forma interactiva, para o que previamente deben solicitar o acceso.

Está o API REST xa dispoñible para conectarme?

A dispoñibilidade do API móstrase no espazo de “Formatos de intercambio” de CoFFEE no Catálogo de Sistemas de Información.

Cal é a última versión dispoñible?

As diferentes versións e o seu estado atópanse dispoñibles no espazo de“Formatos de intercambio” de CoFFEE no Catálogo de Sistemas de Información.

Hai mecanismos alternativos ao API para proporcionar información á plataforma?

Si, dependendo do tipo de información a reportar, o sistema proporcionará mecanismos para que a información proporciónese de forma interactiva polos usuarios que se conecten a el, e tamén mediante a incorporación (interactiva) dun arquivo con todos os datos a tratar.
Naturalmente, CoFFEE realizará las mismas validaciones cuando se proporcione la información de forma masiva a través de la carga de un fichero.

Cal é o formato de codificación do ficheiro JSON que se carga en CoFFEE?

A codificación é Utf-8.

Conexión e uso do servizo

Como solicito o acceso ao API e que procedemento desencadea?

Pódese solicitar o acceso ao API a través da opción “Solicitar este servizo web” do servizo web “CoFFEE-MRR Servizo de Intercambio” no Catálogo de Servizos Web do Portal de Administración Orzamentaria, a partir do momento en que se anuncie que o servizo está dispoñible.
O procedemento pódese resumir nestes puntos:
1.     O responsable do sistema que vai integrarse con CoFFEE solicita o acceso; durante o proceso concrétase o certificado electrónico que se usará para a comunicación segura.
2.    Un responsable funcional de CoFFEE na Secretaría Xeral de Fondos Europeos (SGFE), tras verificar a lexitimidade do solicitante, aproba a autorización.
3.     Os servizos técnicos da Oficina de Informática Orzamentaria asignan un código de “usuario de servizo”. En colaboración coa SGFE, asígnase dentro de CoFFEE un perfil de acceso para o este usuario de servizo, o que determina o ámbito de información sobre a que poderá traballar a través do intercambio electrónico..
4.     Proporciónase ao contacto técnico do sistema que se quere integrar con CoFFEE o código do usuario do servizo (denominado “idUsuario”), ademais dun código identificativo do propio servizo (“idAplicacion”), que deberá conservar para o seu uso nas invocacións ao servizo.
 

Como se logra a seguridade no acceso?

Os servizos Web cliente autenticaranse mediante HTTPS/TLS (1.2 ou superior). En concreto, utilizarase un certificado de selo de Administración, órgano ou entidade de dereito público para actuación administrativa automatizada, ou un certificado de selo electrónico cualificado derivado do Regulamento eIDAS, emitido en calquera caso por algún dos prestadores de servizos de certificación recoñecidos polo servizo @Asina.

Durante o proceso organizativo de autorización de acceso acórdase entre a Oficina de Informática Orzamentaria e o contacto técnico do organismo interesado o certificado que utilizará o extremo cliente do servizo.

Como é unha interacción típica co servizo (unha chamada a un método do API)?

Unha vez finalizou o proceso de autorización do acceso, o sistema cliente está en condicións de facer uso do servizo. Para iso, toda interacción levará a cabo baixo unha comunicación segura (TLS) utilizando o certificado de selo preacordado.
Cada chamada ao servizo REST incluirá no pedimento HTTP, ademais dos parámetros indicados na documentación do propio servizo, dous parámetros adicionais (idUsuario e idAplicacion), que conterán os valores que se facilitaron durante o proceso de configuración do acceso.

¿Poden varias organizacións utilizar o mesmo certificado de selo para interactuar co API?

Aínda que non é habitual, esa posibilidade habilítase se se tramitan dúas solicitudes de acceso, unha por cada unha das organizacións, e configúrase o mesmo certificado en ambas. No proceso de autorización crearase e asignará un usuario de servizo (idUsuario) distinto para cada unha delas, e configuraranse en CoFFEE os correspondentes perfís que actúen en cada un dos ámbitos.
DDado que cada pedimento ao servizo inclúe entre os seus parámetros o código de usuario de servizo (idUsuario), CoFFEE poderá determinar a orixe e poderá actuar en consecuencia, aplicando o perfil de seguridade correspondente.
Non obstante o anterior, hai que ter en conta que se unha das organizacións utilizase o idUsuario asignado á outra, non existiría ningún mecanismo para identificar a suplantación, polo que esta posibilidade levará a cabo a risco das organizacións cliente.

Hai límites establecidos para o uso do servizo?

Definíronse os seguintes límites:
  • Tamaño máximo de pedimento: 100MB.
  • Tamaño máximo de documento: 60MB.
  • Límite máximo de elementos nunha colección: 100 elementos.
  • Número de pedimentos por minuto: pendente de establecer.

Preguntas xerais sobre o API

Cal é o formato das datas?

Séguese a especificación OpenApi 3.0 que fai referencia á definición RFC 3339, sección 5.6, por exemplo 2022-07-21.
É importante destacar que algunhas datas solicitadas débense especificar en trimestres.

Son todos os campos do API obrigatorios?

Non, só son obrigatorios aqueles campos que están marcados como tales (cun asterisco en vermello).

Podo enviar múltiples declaracións de execución contable na mesma chamada POST?

Si, cada chamada pode conter cantas declaracións deséxense do mesmo declarante (un único declarante), como vén especificado no tipo de datos “DeclaracionEjecucion” do esquema.

En relación ás declaracións de progreso de indicadores: o campo “data” (a data de referencia do progreso), ten que ser a data actual?

A data de referencia do progreso dun indicador é aquela en que se considera alcanzado o valor do indicador que se actualiza, e por tanto ten que ser anterior ou igual á data actual, é dicir, non se permiten datas futuras.

Por que no caso de indicadores cuantitativos infórmase a “variación” e no caso de indicadores cualitativos infórmase o “valor”?

Os indicadores son medidores do progreso e poden ser cuantitativos (o seu valor é un dato numérico dentro dun rango) ou cualitativos (poden adoptar un valor de entre un conxunto pechado de opcións)
  • No caso de indicadores cuantitativos débese informar a variación producida desde o valor anterior do indicador. Por exemplo, se o indicador é “Número de vehículos eléctricos matriculados” e pasouse de 1000 a 3000 vehículos, declararase “2000”.
  • No caso de indicadores cualitativos débese informar o novo valor que tomou de entre os posibles (inicio, en curso e finalizado).
O motivo polo que para os indicadores cuantitativos proporciónase a variación é que o sistema permite incorporar unha xustificación (textual e, opcionalmente, acompañada de arquivos). Enténdese que no momento da declaración está a xustificarse o valor incrementado (ou decrementado) dun indicador, e non o valor final alcanzado (no exemplo anterior, xustifícanse os 2000 vehículos que se matricularon).
No caso dos indicadores cualitativos, prodúcese un cambio no seu estado, e por tanto declárase o estado alcanzado.

En relación ás declaracións de execución contable: o campo “fechaContable” (A data de referencia do progreso), pode ser unha data posterior á actual?

A data contable ten que ser anterior ou igual á data actual, é dicir, non se permiten datas futuras.

Que é a referencia dun instrumento xurídico?

Nas declaracións de execución contable especifícase unha referencia do instrumento xurídico baixo o que se fai a declaración. O caso típico é un contrato ou unha subvención, pero todos os instrumentos previstos deben poder ser identificados.
A referencia é, por tanto, un código que identifica o instrumento xurídico concreto no ámbito da Actuación para a que se rexistra a execución.
Habitualmente a referencia coincide co propio código do instrumento que establece a persoa que o dá de alta en CoFFEE (ben sexa por pantalla, carga masiva, ...).
Por exemplo, no caso dunha subvención dada de alta en CoFFEE co código BDNS "576282", a referencia é exactamente ese mesmo código. Ou un contrato (non PLACSP) que se deu de alta en CoFFEE co código de contrato "2023OIP45544", terá ese mesmo código como referencia.
Con todo, hai un caso máis complexo que é o dos contratos PLACSP, e que se trata especificamente na seguinte cuestión.

Como se diferencia un contrato que está dado de alta na Plataforma de Contratación do Sector Público (PLACSP) dun que non o está?

Os contratos PLACSP identifícanse por tres códigos: código de órgano de contratación, código de licitación, e código de contrato (ver seguinte cuestión para unha explicación detallada). Os contratos non PLACSP identifícanse mediante un único código.
Nas entradas de alta de contratos en CoFFEE, os dous tipos de contrato identifícanse de forma separada.
Dado que as referencias de instrumentos xurídicos fanse a través dun único campo, no caso de contratos PLACSP (que, como se indicou, teñen tres códigos) a referencia corresponde á concatenación do tres valores utilizando o separador “” entre eles, mesmo aínda que os campos estivesen baleiros.

Que son os códigos órgano de contratación, de licitación e de contrato de PLACSP?

O código do órgano de contratación é un identificador que usa a Plataforma de Contratación do Sector Público (PLACSP) asociado a cada un dos órganos (en PLACSP denomínase “IDE Plataforma”). Cada órgano de contratación pode consultar o seu propio na pantalla de administrador do perfil “administrador do órgano de contratación” de PLACSP.
PLACSP1.PNG
Ademais, a Dirección Xeral de Patrimonio do Estado publica periodicamente a relación de códigos nunhafolla Excel que van actualizando.
No caso de PLACSP e para cada órgano de contratación, os códigos de licitación e de contrato son os que identifican de forma única un contrato que se incorpora á Plataforma de Contratos do Sector Público:
O código de licitación correspóndese co Número de Expediente na PLACSP, que é o número de expediente que proporciona cada órgano de contratación.
O código de contrato corresponde co Contrato da PLACSP. É tamén un valor que determina o órgano de contratación. Corresponde a cada contrato dentro do expediente.
En calquera caso, ambos son valores que proporciona o xestor á PLACSP. Ambos pódense ver na seguinte imaxe:
PLACSP2.PNG

Cando se cobre o campo “Outras Fontes de financiamento”?

A información sobre outras fontes de información cubrirase cando a actuación á que corresponde a operación estea financiada por algunha outra fonte, de maneira adicional ao financiamento con cargo ao Mecanismo de Recuperación e Resiliencia. Neste caso, identificarase o mecanismo ou fondo que financiou a operación.
 

Para o caso de envío de información contable: teñen que estar dados de alta en CoFFEE previamente á remisión de información os contratos/subvenciones que se inclúan?

Si, é necesario que os terceiros estean dados de alta en CoFFEE previamente á remisión da información contable. O API proporciona os servizos necesarios

No caso de envío de información contable, teñen que estar dados de alta en CoFFEE previamente á remisión de información os terceiros (beneficiarios, contratistas, etc.) que se inclúan?

Si, é necesario que os terceiros estean dados de alta en CoFFEE previamente á remisión da información contable. O API proporciona os servizos necesarios

No caso de fases contables “barradas” (A/, D/, Ou/, AD/, ADO/, PR/, RE/), os importes débense reflectir en positivo ou en negativo?

Os importes en documentos barrados son sempre positivos; a barra xa indica que os importes se tratarán contablemente en negativo.

Unha vez enviada a información de execución contable ou de progreso de indicadores: Recibirei algún xustificante de recepción?

Si, o sistema proporcionará un xustificante de recepción electrónico que permita a rastrexabilidade das operacións.

Cambios destacados de v1.3.1 a v1.5

Se listan os cambios destacados segundo o tipo de datos:
  • Todos os tipos:
    • codigoIniciativa es ahora codigoActuacion
  • Medida:
    • fechaInicio o seu valor é un trimestre
    • fechaFin o seu valor é un trimestre
  • Contrato:
    • contratoPLACSP é agora codigoInstrumento, codigoLicitacion e codigoOrgano
    • contratoNoPLACSP é agora codigoInstrumento
  • Subvencion:
    • convocatoriaBDNS é agora codigoInstrumento
  • Iniciativa:
    • Separada en Proxecto, Subproxecto, SubproyectoInstrumental e Actuacion.
    • fechaInicio o seu valor é un trimestre
    • fechaFin o seu valor é un trimestre
  • DeclaracionFinanciera
  • DeclaracionProgresoIndicador
    • codigoIniciativa agora chámase codigoOrigenProgreso
Por norma xeral, os campos desaparecidos non é necesario informalos.

Cambios destacados de v1.5.0 a v1.5.1

  • Ruta:
    • Actualizouse a ruta POST /ejecucion/outros-instrumentos/destinatarios
    • Actualizáronse as rutas de detalle dun instrumento xurídico. O parámetro {referencia} convértese en parámetro de query. Por exemplo, GET /estrutura/actuacións/{codigo}/convenios/{referencia} convértese en GET /estrutura/actuacións/{codigo}/convenios/detalle?referencia={referencia}
  • Actuacion:
    • Actualizouse o campo transferenciaDeRecursosEconomicosAOtroSubproyecto de Actuacion, convértese en opcional.
    • Engadiuse o campo hitosObjetivosCriticos a Actuacion.
    • Actualizouse o tipo do campo recursosEconomicos de Actución.
  • Subproxecto:
    • Eliminouse o campo costeEstimado de recursosEconomicos de Subproxecto.
  • SubproyectoInstrumental:
    • Eliminouse o campo costeEstimado de recursosEconomicos de SubproyectoInstrumental.

Cambios destacados de v1.5.1 a v1.5.2

  • codigoPropietario O parámetro codigoPropietario pasa a ser opcional nas seguintes rutas:
    • /v1.5/estructura/proxectos
    • /v1.5/estructura/subproxectos
    • /v1.5/estructura/subproxectos-instrumentais
    • /v1.5/estructura/actuacións
    Se non vai incluído, a lista conterá todos os elementos do tipo correspondente aos que o usuario teña acceso.
  • proxecto Os subproxectos, subproxectos instrumentais e actuacións inclúen un resumo do proxecto ao que pertencen (propiedade proxecto).

Preguntas xerais sobre o API v2.0

Como obteño o código único dun instrumento xurídico?

O código único dun instrumento xurídico obtense de tres formas:
  • Alta de instrumento xurídico: na resposta da operación de alta devólvese o código único asignado ao instrumento xurídico. Por exemplo: POST /v2.0/contratos
  • Consulta de instrumentos xurídicos dunha actuación: a listaxe de instrumentos xurídicos inclúe o código único de cada instrumento xurídico. GET /v2.0/actuacións/{codigo}/instrumentos-juridicos
  • Consulta de código único: existe unha utilidade para obter o código único dun instrumento xurídico a partir do código de actuación e a referencia do instrumento xurídico. GET /v2.0/instrumentos-juridicos/utilidades/codigo-unico

Como se realiza a subida de documentos?

A subida de documentos consta de dous pasos:
  • Subida do documento: Engádese un documento novo ao sistema e obtense o localizador necesario para outras operacións. O documento créase co tipo PENDENTE. Os documentos subidos e non asociados a un elemento serán borrados periodicamente. O servizo utilizado é: POST /v2.0/documentos
  • Asociación do documento cun elemento: O documento subido no punto anterior asóciase a un elemento. Na asociación indícase o localizar o documento, o tipo efectivo e os metadatos adicionais. O servizo utilizado depende do elemento, por exemplo, para engadir un documento a un contrato, o servizo é: POST /v2.0/contratos/{codigo-unico}/documentos
Se se desexa asociar o mesmo documento a varios elementos, só é necesario realizar unha vez a subida do documento podendo utilizar o localizador tantas veces como sexa necesario.

Outras dúbidas

Teño dúbidas funcionais sobre a xestión do Plan de Recuperación Transformación e Resiliencia e o sistema de xestión do mesmo, onde podo dirixirme?

A descrición do funcionamento do Plan articúlase con dúas Ordes Ministeriais:
  • Orde HFP/1030/2021, do 29 de setembro, pola que se configura o sistema de xestión do Plan de Recuperación, Transformación e Resiliencia.
  • Orde HFP/1031/2021, do 29 de setembro, pola que se establece o procedemento e formato da información a proporcionar polas Entidades do Sector Público Estatal, Autonómico e Local para o seguimento do cumprimento de fitos e obxectivos e de execución orzamentaria e contable das medidas dos compoñentes do Plan de Recuperación, Transformación e Resiliencia.

Teño máis dúbidas técnicas relacionadas co API, onde podo dirixirme?

Para o resto de dúbidas técnicas sobre o API REST de CoFFEE, pódese escribir unha mensaxe á dirección de correo electrónico de soporte CoFFEE-Desarrollo@igae.hacienda.gob.es
Desde esta caixa de correos atenderanse exclusivamente consultas de carácter técnico referidas ao intercambio de información coa plataforma.