API Information

API – Application Programmers Interface
Ringgold’s API is a REST service responding with JSON formatted data allowing access to top-level organizations and their ISNI identifiers.

2020-02-12: added to our SwaggerHub library: Ringgold-Identify-ISNI/1.0.0 (version OAS 3.0)

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
    • (HTTP GET) /api/isni/search – return collection of institutions matching search key
  •  Endpoints:
    • stable
      • /api/stable/institution/isni_id
      • /api/stable/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)