About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:apis

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
development:apis [2016/10/11 19:32] – created emaijaladevelopment:apis [2022/09/12 15:12] (current) – Struct data changed emaijala
Line 1: Line 1:
 ====== VuFind APIs ====== ====== VuFind APIs ======
- 
-Available from version 4.0. 
  
 The APIs documented on these pages are available on /api endpoint of the VuFind installation (e.g. http://localhost/vufind/api). There is a Swagger UI available for documentation and testing of the APIs on that endpoint. Each API requires proper permissions, so by default the APIs are not available to any user. The only practical way of granting the permissions at the moment is by IP address, such as: The APIs documented on these pages are available on /api endpoint of the VuFind installation (e.g. http://localhost/vufind/api). There is a Swagger UI available for documentation and testing of the APIs on that endpoint. Each API requires proper permissions, so by default the APIs are not available to any user. The only practical way of granting the permissions at the moment is by IP address, such as:
Line 15: Line 13:
 The above would allow access only from localhost. All APIs support CORS with no origin limits and return data in JSON format.  The above would allow access only from localhost. All APIs support CORS with no origin limits and return data in JSON format. 
  
-==== Swagger UI and Specification ====+===== Swagger UI and Specification =====
  
 There is a Swagger UI available with in-depth documentation on the /api endpoint, e.g. http://localhost/vufind/api. You can also access the Swagger specification directly at http://localhost/vufind/api?swagger. There is a Swagger UI available with in-depth documentation on the /api endpoint, e.g. http://localhost/vufind/api. You can also access the Swagger specification directly at http://localhost/vufind/api?swagger.
Line 21: Line 19:
 The Swagger UI is driven by the specification, but it can also be used to create a client library for many programming languages. See http://swagger.io/swagger-codegen/ and http://petstore.swagger.io/ for more information and tools to do the job. The Swagger UI is driven by the specification, but it can also be used to create a client library for many programming languages. See http://swagger.io/swagger-codegen/ and http://petstore.swagger.io/ for more information and tools to do the job.
  
-==== Available APIs ====+===== Available APIs =====
  
   * [[development:apis:search|Search API]]   * [[development:apis:search|Search API]]
   * [[development:apis:record|Record API]]   * [[development:apis:record|Record API]]
 +  * [[development:apis:index2search|Secondary Index Search API]]
 +  * [[development:apis:index2record|Secondary Index Record API]]
 +  * [[development:apis:admin|Admin API (only for clearing cache at the moment)]]
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : emaijala
 ---- ----
  
development/apis.1476214377.txt.gz · Last modified: 2016/10/11 19:32 by emaijala