WeGA API
⚠️ DEPRECATION WARNING ⚠️ This version of the WeGA API specification is outdated and superseded by [version…
Data & analytics#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
⚠️ DEPRECATION WARNING ⚠️ This version of the WeGA API specification is outdated and superseded by version 1.1.0. For feedback or requests about this API please contact stadler@weber-gesamtausgabe.de or start the discussion at https://github.com/Edirom/WeGA-WebApp
Endpoints 10
Documents
- GETLists all documents
/documents?docType=biblio&offset=1&limit=10The Documents endpoint returns a list of all documents from the WeGA digital edition. - GETFinds documents by author
/documents/findByAuthor/:authorID?docType=biblio&offset=1&limit=10This endpoint returns a list of documents by a given author – optionally filtered by document type - GETFinds documents by date
/documents/findByDate?fromDate=1786-11-18&toDate=2024-01-01&docType=biblio&offset=1&limit=10This endpoint returns a list of documents related to the given date – optionally filtered by document type. - GETFinds documents by reference
/documents/findByMention/:docID?docType=biblio&offset=1&limit=10This endpoint returns a list of documents that reference a particular docID – optionally filtered by document type. - GETReturns documents by ID
/documents/:docIDThis endpoint returns documents, indicated by an ID. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g.…
Search
- GETSearch for a WeGA entity
/search/entity?docType=biblio&q=string&offset=1&limit=10This endpoint returns the search results for an entity's name or title.
Code Samples
- GETFinds code samples by XML element
/code/findByElement/:element?namespace=http://www.tei-c.org/ns/1.0&docType=biblio&offset=1&limit=10
Application
- GETCreate a new WeGA ID
/application/newID?docType=biblio - GETGet status information about the running WeGA-WebApp
/application/status
Facets
- GETReturns facets
/facets/:facet?scope=string&term=string&docType=biblio&offset=1&limit=10
API details
- Base URL
http://localhost:8080/exist/apps/WeGA-WebApp/api/v1- Authentication
- None declared in the description
- Operations
- 10 operations on 10 pathsGET 10
- Main resources
- Documents 5Application 2Code Samples 1Facets 1Search 1
- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the WeGA API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the WeGA API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Lists all documents” (GET /documents?docType=biblio&offset=1&limit=10), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the WeGA API?
⚠️ DEPRECATION WARNING ⚠️ This version of the WeGA API specification is outdated and superseded by [version… It is listed under Data & analytics and has 10 endpoints.
Who publishes the WeGA API?
It is listed from Weber Gesamtausgabe's public API description (an OpenAPI document), not published by Weber Gesamtausgabe on Swastik Codes. Anyone who controls weber-gesamtausgabe.de can claim the profile by adding a DNS TXT record.
What is the base URL of the WeGA API?
Requests go to http://localhost:8080/exist/apps/WeGA-WebApp/api/v1. Endpoint paths are added to this base URL.
How do I authenticate with the WeGA API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the WeGA API have?
10 operations on 10 paths (10 GET). The largest groups are Documents, Application, Code Samples, Facets.
Is forking the WeGA API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.