Instruktioner

Här finns instruktioner och mer teknisk information avseende hur man använder de GDP API endpoints som tillhandahålls i den här portalen.

API endpoints

Följande endpoints är tillgängliga:

• API Metadata: 

  Hämtar information om API:et.

  • Forte: https://api.forte.se/gdp_forte/metadata

  • Formas: https://api.formas.se/gdp_formas/metadata

  • Vetenskapsrådet: https://api.vr.se/gdp_vr/metadata

  • Vinnova: https://api.vinnova.se/gdp_vinnova/metadata

• Utlysningar:

  Hämtar en lista med utlysningar genom att ange en eller flera sökparametrar. Listan är sorterad i fallande diarienummerordning.

  • Forte: https://api.forte.se/gdp_forte/utlysningar

  • Formas: https://api.formas.se/gdp_formas/utlysningar

  • Vetenskapsrådet: https://api.vr.se/gdp_vr/utlysningar

  • Vinnova: https://api.vinnova.se/gdp_vinnova/utlysningar

• Ansökningar:

  Hämtar en lista med ansökningar genom att ange en eller flera sökparametrar. Listan är sorterad i fallande diarienummerordning.

  • Forte: https://api.forte.se/gdp_forte/ansokningar

  • Formas: https://api.formas.se/gdp_formas/ansokningar

  • Vetenskapsrådet: https://api.vr.se/gdp_vr/ansokningar

  • Vinnova: https://api.vinnova.se/gdp_vinnova/ansokningar

• Finansierade Aktiviteter: 

  Hämtar en lista med finansierade aktiviteter genom att ange en eller flera sökparametrar. Listan är sorterad i fallande diarienummerordning.

  • Forte: https://api.forte.se/gdp_forte/finansieradeaktiviteter

  • Formas: https://api.formas.se/gdp_formas/finansieradeaktiviteter

  • Vetenskapsrådet: https://api.vr.se/gdp_vr/finansieradeaktiviteter

  • Vinnova: https://api.vinnova.se/gdp_vinnova/finansieradeaktiviteter

Autentisering och generering av API-nyckel

För att använda GDP API behöver du en API-nyckel. Du behöver skapa en API-nyckel för respektive myndighets GDP API. Denna nyckel ska inkluderas i alla anrop till API:et som 'Authorization'.

Skapa din API-nyckel/prenumeration genom att gå till menyn ”Skapa API-nyckel” och följa instruktionerna där. Efter att du genererat din API-nyckel finns den sparad i din profil som du är inloggad i portalen med. Du kan se dina aktiva nycklar genom att navigera till menyn ”Min profil”.

Notera att du behöver skapa en API-nyckel för respektive myndighets GDP API.

Exempel:

https://api.forte.se/gdp_forte/metadata?authorization=API-nyckel_Forte

https://api.formas.se/gdp_formas/metadata?authorization=API-nyckel_Formas

https://api.vr.se/gdp_vr/metadata?authorization=API-nyckel_VR

https://api.vinnova.se/gdp_vinnova/metadata?authorization=API-nyckel_Vinnova

Filtrering

För att filtrera svaret från API:et finns möjlighet att använda olika parametrar om så önskas, beroende på vilken endpoint som används. En eller flera parametrar kan användas samtidigt.

• diarienummer - Filtrera efter ansökning, utlysning eller program. Inmatningen ska vara kommaseparerad om flera diarienummer anges och är begränsad till maximalt 1200 tecken.

• organisationsnummer - För att hitta ansökningar kopplade till en specifik organisation. Inmatningen ska vara kommaseparerad om flera organisationsnummer anges och är begränsad till maximalt 1200 tecken.

• franBeslutDatum/tillBeslutDatum - Använd för att filtrera ansökningar baserat på beslutsdatum.

• status - Filtrera ansökningar baserat på deras aktuella status.

Paginering

För att hantera stora volymer av data effektivt använder API:et pagineringsparametrarna limit och offset. Dessa parametrar hjälper till att kontrollera antalet poster som returneras i varje svar och att navigera genom datamängderna.

• limit - Specificerar maximalt antal poster som ska returneras i svaret.

• offset - Anger startpunkten för datahämtningen, vilket är användbart vid paginering.

Exempel: För att hämta de första 50 ansökningarna använd limit=50 och offset=0. För att därefter hämta de nästa 50 ansökningarna, använd limit=50 och offset=50.

Exempel på API-anrop

För att använda filtrerings- och pagineringsparametrar i praktiken, här är ett exempel på hur ett anrop till API:et kan se ut när du vill hämta 50 senast beviljade ansökningar:

https://api.forte.se/gdp_forte/ansokningar?authorization=API-nyckel_Forte?status=Beviljad&limit=50&offset=0

https://api.formas.se/gdp_formas/ansokningar?authorization=API-nyckel_Formas?status=Beviljad&limit=50&offset=0

https://api.vr.se/gdp_vr/ansokningar?authorization=API-nyckel_VR?status=Beviljad&limit=50&offset=0

https://api.vinnova.se/gdp_vinnova/ansokningar?authorization=API-nyckel_Vinnova?status=Beviljad&limit=50&offset=0