Voor ontwikkelaars

Het Publicatiebureau stelt een aantal API’s ter beschikking in verband met de TED-website en Europese overheidsopdrachten.

Met deze API’s kunt u:

verlicht Het Publicatiebureau geeft toegang tot deze API’s, maar biedt geen technische ondersteuning bij het gebruik ervan.

 

Algemene informatie

De registratievereisten en authenticatiemechanismen van onze API’s zijn afhankelijk van het gebruik en het beoogde publiek. Lees de beschrijvingen van de afzonderlijke API’s voor nadere bijzonderheden.

Onze API’s zijn gebaseerd op REST en maken gebruik van standaard HTTP-responsecodes. Het dataformaat voor requests en responses is JSON. Voor bijna alle API’s geven we een gestructureerde beschrijving met behulp van de OpenAPI-specificatie versie 2.0 (“Swagger”).

Wanneer een aankondiging in XML-formaat in de JSON-data wordt ingebed, wordt deze in Base64 gecodeerd en als string behandeld. Dit voorkomt problemen met tekens die in JSON een specifieke betekenis hebben (aanhalingstekens, komma’s enz.).

Versiebeheer

Wanneer we in een API een wijziging aanbrengen die niet achterwaarts compatibel is, creëren we een nieuwe versie. Het versienummer maakt deel uit van de URL’s, bijvoorbeeld “.../v2/...”.

De volgende wijzigingen worden als achterwaarts compatibel beschouwd:

  • toevoeging van nieuwe API-commando’s
  • toevoeging van nieuwe facultatieve inputparameters aan bestaande API-commando’s (in JSON of in de zoekstring)
  • toevoeging van nieuwe JSON-property’s aan bestaande API-responses
  • verandering van de volgorde van property’s in bestaande API-responses
Aanbevelingen voor client-implementaties

Om de compatibiliteit te garanderen, moeten onverwachte velden door de client worden genegeerd. Ga er niet vanuit dat de JSON-velden in een bepaalde volgorde staan.

In de header van elk HTTP-request moet de “User-Agent” worden gedefinieerd. Doe dit zo nauwkeurig mogelijk, dat helpt ons bij het analyseren van eventuele problemen.

 

Opvragen van gepubliceerde gegevens

Voor de hier beschreven commando’s is geen registratie of authenticatie nodig.

Vanaf 14 november 2022 zullen de aankondigingen op de TED-website voldoen aan de specificaties van formulieren op basis van TED-schema’s en e-formulieren.

De formulieren op basis van TED-schema’s (gebaseerd op een interoperabiliteitsnorm van het Publicatiebureau) zijn opgenomen in Verordening (EU) 2015/1986. Documentatie is beschikbaar op de website EU Vocabularies.

De e-formulieren zijn opgenomen in Verordening (EU) 2019/1780, die nieuwe standaardformulieren voor overheidsopdrachten introduceerde. De verordening inzake e-formulieren treedt op 14 november 2022 in werking. De e-formulieren zijn gebaseerd op de interoperabiliteitsnorm UBL (Universal Business Language). Meer informatie is te vinden op de speciale SIMAP-pagina.

Als u TED-aankondigingen hergebruikt, moet u uw systemen aanpassen om de nieuwe aankondigingen te ondersteunen.

 
Zoeken en downloaden van aankondigingen

U kunt aan de hand van verschillende criteria op TED gepubliceerde aankondigingen van overheidsopdrachten zoeken en specifieke gegevens downloaden over de aankondigingen die aan uw criteria beantwoorden. Als zoekstring gebruikt u dezelfde zoekstring als voor geavanceerd zoeken.

Met een specifiek commando kunt u ook het aantal aankondigingen per geografisch gebied (NUTS-code) opvragen. De TED-website gebruikt deze informatie om de kaart “Plaats van uitvoering” aan te maken.

Meer informatie hierover vindt u in de API-documentatie.

Op de TED-website kunt u ook de aankondigingen groepsgewijs in XML-formaat downloaden. Eén archiefbestand bevat dan alle aankondigingen voor een bepaalde dag of maand.

De XML-schema’s voor de aankondigingen en de bijbehorende documentatie vindt u op de website EU Vocabularies.

Een subset van de gegevens uit de aankondigingen op TED is ook als dataset in CSV-formaat beschikbaar op data.europa.eu.

Aankondigingen in verschillende formaten bekijken

Op basis van de inhoud van een aankondiging in XML-formaat kunt u de aankondiging ook verkrijgen in HTML- of PDF-formaat en in een specifieke taal.

Er zullen twee verschillende API’s beschikbaar zijn: een voor het bekijken van aankondigingen op basis van TED-schema’s en één voor het bekijken van aankondigingen op basis van e-formulieren.

  • De methode om aankondigingen op basis van TED-schema’s te bekijken, wordt beschreven in de documentatie van de TED Notice Viewer-API;
  • de methode om aankondigingen op basis van e-formulieren te bekijken, wordt beschreven in de documentatie van de TED eForms Notice Viewer.
Gepubliceerde aankondigingen van aanbestedingen van EU-instellingen

U kunt een lijst opvragen van aanbestedingen van EU-instellingen, zoals gepubliceerd op de website eTendering.

De lijst met basisgegevens over elke aanbesteding kan worden gefilterd op:

  • naam van de aanbestedende dienst;
  • status van de aanbesteding;
  • taal.

Meer informatie hierover vindt u in de API-documentatie in PDF-formaat.

 

Aankondigingen indienen voor publicatie

Openbare of particuliere instanties die “TED eSender” zijn, kunnen met hun eigen softwaresysteem aankondigingen indienen voor publicatie op TED. Zie hiervoor onze pagina TED eSender worden.

De betrokken commando’s kunnen alleen worden gebruikt door eSenders en aanvragers van de eSender-status. De beveiliging gebeurt met basisauthenticatie via HTTPS.

Hoe u als eSender aankondigingen voor publicatie op de TED-site kunt uploaden, leest u in de documentatie over de productie-API van eSentool.

Dezelfde commando’s zijn op twee andere eindpunten beschikbaar voor eSender-aanvragers:

  • om het publiceren van aankondigingen te simuleren, kunnen ze gebruikmaken van de simulatie-API van eSentool, die beschreven wordt in de desbetreffende API-documentatie;
  • om in aanmerking te komen voor het publiceren van aankondigingen, kunnen ze gebruikmaken van de kwalificatie-API van eSentool, die beschreven wordt in de desbetreffende API-documentatie.

 

Integratie in het aanbestedingsproces

We bieden verschillende commando’s aan om onze applicaties in het ruimere aanbestedingsproces te integreren, zoals:

  • het opstellen of bijwerken van een ontwerpaankondiging in eNotices;
  • het opvragen van informatie over een aankondiging tijdens de publicatieperiode;
  • het opvragen van het aantal woorden en tekens waaruit een aankondiging bestaat.

Alleen EU-instellingen hebben momenteel toegang tot deze commando’s. Er zijn verschillende authenticatiemethoden beschikbaar.

Meer informatie hierover vindt u in de API-documentatie.