API Information

API – Application Programmers Interface
Our API is a ‘REST’ service responding with JSON formatted data allowing access to over 400,000 ISNI identifiers and data.

Now with swagger 2.0 specification file here.

Features:

  • Base url:
    • isni.ringgold.com
  • Protocol:
    • REST – returns JSON objects
  • Services:
    • (HTTP GET) /api/institution/isni_id – return and institution json object for supplied isni_id
    • (HTTP GET) /api/isni/search_key – return collection of institutions matching search key
  •  Endpoints:
    • stable
      • /api/stable/institution/isni_id
      • /api/stable/search?q=searchkey
    • release-candidate (under development and may contain errors)
      • /api/rc/institutions/isni_id
      • /api/rc/isni/search?q=searchkey
  • JSON objects:
    • institution
      • isni
      • name
      • alt_names (array of name)
      • locality
      • admin_area_level_1
      • country_code
      • post_code
      • urls (array of url)
    • institutions (aka search_results)
      • search_total_count
      • offset
      • limit
      • institutions (array of institution objects)