Quick Start
Use the information in this topic to help you get started with OIRI REST APIs.
Prerequisites
| Prerequisite | More Information |
| Install cURL | Use cURL |
| Set up authentication | Authenticate |
| An OIG account with OrclOIRIRoleEngineer role | An OIG account is required with the OrclOIRIRoleEngineer role assigned to it to use the REST API. |
Invoke the OIRI REST API
To invoke the REST API:
- Get access token by running the following cURL command:
curl -v -H "Content-Type: application/json" -X POST "http://localhost:<PORT>/oiri/api/v1/authenticate/token" -d ' { "username":"<USERNAME>", "password":"<PASSWORD>" }'The user must exist in OIG, and it must have the role OrclOIRIRoleEngineer assigned to it. The REST API returns the access token.
- Use the access token in accessing all REST API using Bearer header token, as shown:
curl -v -H 'Authorization: Bearer eyJraWQiOiJvaXJpIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJ3d3cub3JhY2xlLmNvbSIsImF1ZCI6Ind3dy5vcmFjbGUuY29tIiwiZXhwIjoxNjE3ODc5ODg2LCJqdGkiOiJ0b0x4YTdCOVVvVk94TDF2bFYtMk5nIiwiaWF0IjoxNjE3ODc4Njg2LCJzdWIiOiJyb2hpdCByYXdhdCIsImVtYWlsIjpudWxsLCJ1c2VyTG9naW4iOiJST0hJVC5SQVdBVEBPUkFDTEUuQ09NIiwicm9sZXMiOlsiT3JjbE9JUklSb2xlRW5naW5lZXIiXX0.gyCsDDVihF-WneFp042zKfAJ2DuMzO3uue0AlsttgGEIH3mur21CuZJQD7qrAz4kqsbSVy1H2fF4CQlHLP9ponmVA5zdzpGMv7eBMlcVtdOW4s7_5US3m5bZSG2blKVR6Z_6975WGVKjQXzhbCSHRNp750w8ZmoB1ye7g5NDoRtQAWlI3N5jNdk2eGcWw3m-9sGltEK1AqYXk_ZwHiba14iZIZobfl4XDtwlYq09eqxqNQff-r7ixWIRfXDft5eiBHG43ryARjhMBxa_1VD8tg0ldgDOFWcJT9LJXB0AGAIZII4HrkhkEO62LyOv63FMqfSovTcQwIEoZA0QPZn8oQ' GET http://localhost:<PORT>/oiri/api/v1/tasks/1615360622982