Brontekst bekijken van BME:API

De API van de BME wordt gebruikt om nieuwe records aan te maken of bestaande records te wijzigen. De gegevens dienen via een POST of GET request te worden doorgegeven. Het aanvragen van een BME-ticket (create) dient middels een POST-request te gebeuren. Applicatie-authenticatie vindt plaats op basis van een [[#account|account]].

== Endpoints ==
* <nowiki>http://metaplus.kennisnet.nl/bme/</nowiki>
* <nowiki>http://metaplus.acceptatie.kennisnet.nl/bme/</nowiki>
Bij het testen kan gebruik gemaakt worden van de acceptatieomgeving van de BME. De acceptatieomgeving van de BME is gekoppeld aan de stagingomgeving van Edurep (voor controle op dubbelingen).

== Acties ==
Een overzicht van de ondersteunde acties:
{| class="wikitable"
! POST/GET endpoint
! omschrijving
|-
| ?r=ticket%2Fcreate
| aanvragen ticket [[BME:API/create|Lees meer]]
|-
| ?r=ticket%2Facknowledge
| bevestigen bewerken mogelijk dubbel record [[BME:API/acknowledge|Lees meer]]
|-
| ?r=ticket%2Fview
| opvragen status [[BME:API/view|Lees meer]]
|-
| ?r=ticket%2Fresult
| opvragen resultaat document [[BME:API/result|Lees meer]]
|}

== Voorbeeld Verzoek ==
 <nowiki>http://www.metaplus.kennisnet.nl/bme/?r=ticket%2Fview&ticket=4f68b193b25e4&application_id=demo&application_password=demo</nowiki>

== Voorbeeld Respons ==
<syntaxhighlight lang="xml">
<ticket-status>
  <status>completed</status>
  <ticket>4f68b193b25e4</ticket>
  <repositoryId>{repository id}</repositoryId>
  <callback-url>http://example.com/record/43/metadatacompleted</callback-url>
</ticket-status>
</syntaxhighlight>

== Account ==
Alleen geautoriseerde diensten kunnen sessies aanmaken en bevragen. Voor authenticatie is een applicatie identifier en een wachtwoord nodig. Neem hiervoor contact op met onze {{servicedesk}}. Voor het bewerken van record in de BME wordt de gebruiker gestuurd naar een URL met een sessie id. Dit id is een willekeurige waarde van een dusdanige grootte dat deze nagenoeg onmogelijk te raden is.

== Statuscodes ==
{{:BME:Statuscodes}}

== Foutmeldingen ==
{{:BME:Foutmeldingen}}

[[Categorie:BronMetadataEditor]]
[[Categorie:Interface]]