Home

Welcome to the ror-developer-docs wiki!

ROR services overview

API

RESTful API that allows searching/retrieving ROR records. Also contains private routes for indexing data into Elasticsearch and generating new IDs. Docker container deployed to AWS Fargate via Gitub Actions.

• Language: Python (Django)
• User docs: https://ror.readme.io/docs/rest-api
• Github repo: ror-api
• URL (production): https://api.ror.org/organizations
• URL (staging): https://api.staging.ror.org/organizations
• URL (dev): https://api.dev.ror.org/organizations

Search UI

JS app the allows searching/viewing ROR records in a browser. Deployed to AWS S3/Cloudfront via Github Actions.

• Language: Javascript (Ember)
• User docs: https://ror.readme.io/docs/web-search-interface
• Github repo: ror-app
• URL (production): https://ror.org/search
• URL (staging): https://staging.ror.org/search
• URL (dev): https://dev.ror.org/search

Info site

Static site with informational content about ROR. Deployed to AWS S3/Cloudfront via Github Actions.

• Language: Static HTML generated by Middleman Ruby app
• Github repo: ror-site
• URL (production): https://ror.org
• URL (staging): https://staging.ror.org
• URL (dev): https://dev.ror.org

Reconciler

OpenRefine extension that allows matching organization names to ROR IDs using the ROR REST API. Docker container deployed to AWS Fargate via ???

• Language: Ruby
• User docs: https://ror.readme.io/docs/openrefine-reconciler
• Github repo: ror-reconciler
• URL (production): https://reconcile.ror.org/reconcile
• URL (staging): https://reconcile.staging.ror.org/reconcile
• URL (dev): https://reconcile.dev.ror.org/reconcile

Leo form

UI app for generating new or updated ROR record files for download to a local machine. In practice, this is not used by humans, but by a script that takes a CSV as input and uses Selenium to complete the form to create a record each row. Deployed to AWS S3/Cloudfront via Github Actions.

• Language: Javascript (VueJS + JSONForms)
• Github repo: leo-form
• URL (production): https://leo.ror.org
• URL (staging): https://leo.staging.ror.org
• URL (dev): https://leo.dev.ror.org

Generate ID

Middleware app used for handling requests to protected ROR API routes from other apps/code (such as leo-form and scripts used in Github actions). Used to centralize handling of protected requests while obscuring requests paths and credentials. Docker container deployed to AWS Fargate via Gitub Actions.

• Language: Python (FastAPI)
• Github repo: generate-id
• URL (production): https://generateid.ror.org
• URL (staging): https://generateid.staging.ror.org
• URL (dev): https://generateid.dev.ror.org