User API Guide
This section explains how to use the APIs provided by the OSORI project for users.
WARNINGLimitations on the API usage: these user APIs are restricted to use under the condition below.
If more than 5,000 API are called in an hour, we block its usage due to Too Many Request exception.
OSORI User API Base URL
OSORI User API v2.0 (Swagger UI) : Link
Inquiry for the license list
/api/v2/user/licenses
NOTEThis is an API that can retrieve data about the license provided from the OSORI project.
Query parameters in the API
| Name | Type | required | Description |
|---|---|---|---|
|
name
|
string
|
N
|
License name
ex. MIT License |
|
webpage
|
string
|
N
|
A URL address for the license notice
ex. https://opensource.org/licenses/MIT
|
|
equalFlag
|
string
|
Y
|
Configuration for specifying the search results based on the given keyword.
- ‘Y’: Displays the results that exactly match the keyword - ‘N’ (default value): Displays all the results that have the keyword |
|
page
|
int
|
Y
|
The number of start page (mandatory value)
- Default value: 0 |
|
sort
|
string
|
Y
|
Sorting criteria in terms of data entity (mandatory value).
The available entities for the criteria are listed as follows. - name - nickname - id - spdx_identifier |
|
spdxIdentifier
|
string
|
N
|
SPDX license identifier
ex. MIT |
|
modifiedDate
|
string
|
N
|
Date of modification
format : "yyyy-mm-dd" |
|
size
|
int
|
Y
|
The number of retrieved data from the page (mandatory value)
default : 1 |
|
direction
|
string
|
N
|
Sorting order
- ASC: Ascending (default value) - DESC: Descending |
Usage example
curl –location –request GET "https://{osori_base_url}/api/v2/user/licenses?name=Free License&modifiedDate=2023-07-12&equalFlag=N&page=0&size=10&sort=name&direction=ASC"
Header in response
Content-Type application/json
Body in response (JSON)
{
"code": "200",
"messageList": {
"list": [
{
"rownum": 1.0,
"osi_approval": true,
"name": "Academic Free License v2.2",
"obligation_notification": true,
"id": 4,
"obligation_disclosing_src": "NONE"
}
],
"count": 4,
"page": 0,
"size": 10
},
"success": true
}
Details in the response body
| Depth 1 | Depth 2 | Depth 3 | Depth 4 | Depth 5 | Type | Description |
|---|---|---|---|---|---|---|
|
code
|
|
|
|
|
string
|
Code value representing a response status of the API
200: Success |
|
messageList
|
|
|
|
|
object
|
|
|
|
list
|
|
|
|
array
object |
|
|
|
|
name
|
|
|
string
|
License name
|
|
|
|
obligation_disclosing_src
|
|
|
string
|
Scope of source code disclosure in distribution
- NONE - ORIGINAL - FILE - MODULE - LIBRARY - DERIVATIVE WORK - EXECUTABLE - DATA - SOFTWARE USING THIS - UNSPECIFIED |
|
|
|
obligation_notification
|
|
|
boolean
|
Whether or not the obligation of notification exists in distribution
- false : No obligation - true : Obligates notification in its distribution |
|
|
|
osi_approval
|
|
|
boolean
|
Whether or not the license has been approved by OSI
(https://opensource.org/licenses/) |
|
|
count
|
|
|
|
int
|
Total number of the retrieved data
|
|
|
page
|
|
|
|
int
|
Current page number
|
|
|
size
|
|
|
|
int
|
Number of rows per page
|
|
success
|
|
|
|
|
boolean
|
Result of the API call
- false : Failure - true : Success |
Inquiry for detail information of the license
/api/v2/user/licenses/{category}
NOTEThis is an API that allows you to retrieve detail information about the license provided from the OSORI project.
Query parameters in the API
| Name | Type | required | Description |
|---|---|---|---|
|
searchWord
|
string
|
Y
|
Enter the keyword for your search
ex. MIT |
|
page
|
int
|
Y
|
The number of start page (mandatory value)
- Default value: 0 |
|
sort
|
string
|
Y
|
Sorting criteria in terms of data entity (mandatory value).
The available entities for the criteria are listed as follows. - name - nickname - id - spdx_identifier |
|
size
|
int
|
Y
|
The number of retrieved data from the page (mandatory value)
default : 1 |
|
direction
|
string
|
N
|
Sorting order
- ASC: Ascending (default value) - DESC: Descending |
Usage example
curl –location –request GET "https://{osori_base_url}/api/v2/user/licenses/name?searchWord=Apache License 1.1"
Header in response
Content-Type application/json
Body in response (JSON)
{
"code": "200",
"messageList": {
"detailInfo": [
{
"spdx_identifier": "Apache-1.1",
"obligation_notification": true,
"description": null,
"obligation_disclosing_src": "NONE",
"description_ko": null,
"modified_date": "2023-10-31T05:15:57.000+00:00",
"webpageList": null,
"rownum": 1.0,
"osi_approval": true,
"license_text": "Apache License 1.1 \n\nCopyright (c) 2000 The Apache Software Foundation. All rights reserved. \n\nRedistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source cod ",
"name": "Apache License 1.1",
"nicknameList": [
"Apache 1.1",
"Apache License v.1.1",
"Apache Software License version 1.1",
"APACHE1.1"
],
"id": 11,
"webpage": "https://spdx.org/licenses/Apache-1.1.html",
"created_date": "2023-10-24T06:46:20.000+00:00",
"restrictionList": null
}
],
"count": 1,
"page": 0,
"size": 10
},
"success": true
}
Details in the response body
| Depth 1 | Depth 2 | Depth 3 | Depth 4 | Depth 5 | Type | Description |
|---|---|---|---|---|---|---|
|
code
|
|
|
|
|
string
|
Code value representing a response status of the API
200: success |
|
messageList
|
|
|
|
|
object
|
|
|
|
detailInfo
|
|
|
|
array
object |
|
|
|
|
id
|
|
|
int
|
ID of the target retrieved data (primary key)
|
|
|
|
name
|
|
|
string
|
License name
|
|
|
|
webpage
|
|
|
string
|
A URL address for the license notice
|
|
|
|
obligation_disclosing_src
|
|
|
string
|
Scope of source code disclosure in distribution
- NONE - ORIGINAL - FILE - MODULE - LIBRARY - DERIVATIVE WORK - EXECUTABLE - DATA - SOFTWARE USING THIS - UNSPECIFIED |
|
|
|
obligation_notification
|
|
|
boolean
|
Whether or not the obligation of notification exists in distribution
- false : no notification obligation - true : notification obligation exists |
|
|
|
spdx_identifier
|
|
|
string
|
A name of SPDX identifier
|
|
|
|
description
|
|
|
string
|
Description of the license
|
|
|
|
|
description_ko
|
|
string
|
Korean Description of the license
|
|
|
|
license_text
|
|
|
string
|
License notice text
|
|
|
|
osi_approval
|
|
|
boolean
|
Whether or not the license has been approved by OSI
(https://opensource.org/licenses/) |
|
|
|
created_date
|
|
|
string
|
Data registration date
|
|
|
|
modified_date
|
|
|
string
|
Data Modification Date
|
|
|
|
webpageList
|
|
|
array string
|
List of alternative URLs aside from webpage, such as sources of license notices
|
|
|
|
nicknameList
|
|
|
array string
|
List of nicknames for the license
|
|
|
|
restrictionList
|
|
|
array object
|
List of restrictions imposed by the license
|
|
|
|
|
id
|
|
int
|
A id of restriction
|
|
|
|
|
name
|
|
string
|
A name of restriction
|
|
|
|
|
level
|
|
int
|
A level of restriction
|
|
|
count
|
|
|
|
int
|
Total number of the retrieved data
|
|
|
Page
|
|
|
|
int
|
Current page number
|
|
|
Size
|
|
|
|
int
|
Number of rows per page
|
|
success
|
|
|
|
|
boolean
|
Result of the API call
- false : Failure - true : Success |
Inquiry for the Open Source software (OSS) List
/api/v2/user/oss
NOTEThis is an API that allows you to retrieve open source information provided from the OSORI project.
Query parameters in the API
| Name | Type | required | Description |
|---|---|---|---|
|
ossName
|
string
|
N
|
Open Source name
|
|
version
|
string
|
N
|
Open Source version information
|
|
equalFlag
|
string
|
Y
|
Configuration for specifying the search results based on the given keyword.
- ‘Y’: Displays the results that exactly match the keyword - ‘N’(default value): Displays all the results that have the keyword |
|
page
|
int
|
Y
|
The number of start page (mandatory value)
- Default value: 0 |
|
sort
|
string
|
Y
|
Sorting criteria in terms of data entity (mandatory value).
The available entities for the criteria are listed as follows. - name - nickname - version |
|
downloadLocation
|
string
|
N
|
A URL for downloading the given Open Source
ex. github/aerogear-attic/aerogear-android-stor |
|
modifiedDate
|
string
|
N
|
Date of modification
format : "yyyy-mm-dd" |
|
size
|
int
|
Y
|
The number of retrieved data from the page (mandatory value)
default : 1 |
|
direction
|
string
|
N
|
Sorting order
- ASC: Ascending (default value) - DESC: Descending |
Usage example
curl –location –request GET "https://{osori_base_url}/api/v2/user/oss?ossName=Net&modifiedDate=2023-07-12&equalFlag=N&page=0&size=2&sort=name&direction=ASC"
Header in response
Content-Type application/json
Body in response (JSON)
{
"code": "200",
"messageList": {
"oss_master": [
{
"rownum": 1.0,
"name": "DotNetZip",
"oss_master_id": 1,
"version_license_diff": false,
"purl": "link:dotnetzip.codeplex.com/downloads/get/258012",
"version": [
{
"oss_version_id": 1,
"version": null,
"declaredLicenseList": "MS-PL",
"detectedLicenseList": null,
"restrictionList": "Non-Commercial Use Only,Internal Use Only,Patent Warning"
}
]
}
],
"count": 1,
"page": 0,
"size": 2
},
"success": true
}
Details in the response body
| Depth 1 | Depth 2 | Depth 3 | Depth 4 | Depth 5 | Type | Description |
|---|---|---|---|---|---|---|
|
code
|
|
|
|
|
string
|
Code value representing a response status of the API
200: Success |
|
messageList
|
|
|
|
|
object
|
|
|
|
list
|
|
|
|
array object
|
|
|
|
|
name
|
|
|
string
|
Open source name
|
|
|
|
oss_master_id
|
|
|
string
|
ID of the target retrieved Open Source data (primary key)
|
|
|
|
version_license_diff
|
|
|
boolean
|
True if its license is different according to the release version.
|
|
|
|
purl
|
|
|
boolean
|
OSS 대표 링크에 대한 purl
(https://github.com/package-url/purl-spec) |
|
|
|
version
|
|
|
array object
|
Open Source version information
|
|
|
|
|
oss_version_id
|
|
int
|
ID of the version for the given Open Source (primary key)
|
|
|
|
|
version
|
|
string
|
Open Source version information
|
|
|
|
|
declaredLicenseList
|
|
string
|
Representative license defined in the given Open Source version
|
|
|
|
|
detectedLicenseList
|
|
string
|
Additional licenses detected aside from declaredLicense in the given Open Source version
|
|
|
|
|
restrictionList
|
|
string
|
List of restrictions imposed by the given Open Source
|
|
|
count
|
|
|
|
int
|
Total number of the retrieved data
|
|
|
page
|
|
|
|
int
|
Current page number
|
|
|
size
|
|
|
|
int
|
Number of rows per page
|
|
success
|
|
|
|
|
boolean
|
Result of the API call
- false : Failure - true : Success |
Inquiry for detail information of the Open Source
/api/v2/user/oss/{category}/versions
NOTEThis is an API that allows you to retrieve detail information about the Open Source provided from the OSORI project.
Query parameters in the API
| Name | Type | required | Description |
|---|---|---|---|
|
searchWord
|
string
|
Y
|
Enter the keyword for your search
ex. facebook |
|
page
|
int
|
Y
|
The number of start page (mandatory value)
- Default value: 0 |
|
sort
|
string
|
Y
|
Sorting criteria in terms of data entity (mandatory value).
The available entities for the criteria are listed as follows. - name - nickname - version |
|
size
|
int
|
Y
|
The number of retrieved data from the page (mandatory value)
default : 1 |
|
direction
|
string
|
N
|
Sorting order
- ASC: Ascending (default value) - DESC: Descending |
Usage example
curl –location –request GET "https://{osori_base_url}/api/v2/user/oss/name/versions?searchWord=DotNetZip"
Header in response
Content-Type application/json
Body in response (JSON)
{
"code": "200",
"messageList": {
"oss_master": [
{
"rownum": 1.0,
"oss_master_id": 1,
"name": "DotNetZip",
"download_location": "http://dotnetzip.codeplex.com/downloads/get/258012",
"purl": "link:dotnetzip.codeplex.com/downloads/get/258012",
"homepage": "http://dotnetzip.codeplex.com23",
"description": null,
"compliance_notice": "test",
"compliance_notice_ko": "테스트",
"version_license_diff": false,
"attribution": null,
"publisher": null,
"created_date": "2023-11-28T05:15:47.000+00:00",
"modified_date": "2023-11-28T05:15:47.000+00:00",
"downloadLocationList": null,
"purlList": null,
"nicknameList": [
"test",
"test1",
"test23"
],
"oss_version": [
{
"oss_version_id": 1,
"version": null,
"description": null,
"description_ko": null,
"attribution": null,
"license_combination": "AND",
"release_date": null,
"created_date": "2023-10-24 16:28:20",
"modified_date": "2023-10-24 16:28:20",
"copyright": null,
"declaredLicenseList": [
"MS-PL"
],
"detectedLicenseList": null,
"restrictionList": [
"Non-Commercial Use Only",
"Internal Use Only",
"Patent Warning"
]
}
]
}
],
"count": 1,
"page": 0,
"size": 10
},
"success": true
}
Details in the response body
| Depth 1 | Depth 2 | Depth 3 | Depth 4 | Depth 5 | Type | Description |
|---|---|---|---|---|---|---|
|
code
|
|
|
|
|
string
|
Code value representing a response status of the API
200: Success |
|
messageList
|
|
|
|
|
object
|
|
|
|
detailInfo
|
|
|
|
array
object |
|
|
|
|
oss_master_id
|
|
|
int
|
ID of the target retrieved Open Source data (primary key)
|
|
|
|
name
|
|
|
string
|
Open source name
|
|
|
|
download_location
|
|
|
string
|
A download URL for the given Open Source
|
|
|
|
purl
|
|
|
string
|
Package URL (purl) of the representative link to the given Open Source
(https://github.com/package-url/purl-spec) |
|
|
|
homepage
|
|
|
string
|
A URL of the official Open Source website
|
|
|
|
description
|
|
|
string
|
Description of the Open Source
|
|
|
|
compliance_notice
|
|
|
string
|
Summary description of the given Open Source in terms of compliance (value exists only when it has the compliance notice)
|
|
|
|
|
compliance_notice_ko
|
|
string
|
Summary Korean description of the given Open Source in terms of compliance (value exists only when it has the compliance notice)
|
|
|
|
version_license_diff
|
|
|
string
|
True if its license is different according to the release version.
|
|
|
|
attribution
|
|
|
string
|
Matters requiring separate notification
|
|
|
|
publisher
|
|
|
string
|
Distributor or owner (personel or organization)
|
|
|
|
created_date
|
|
|
string
|
Data registration date
|
|
|
|
modified_date
|
|
|
string
|
Data Modification Date
|
|
|
|
downloadLocationList
|
|
|
array string
|
Additional links to download the given Open Source
ex. http://github.com |
|
|
|
purlList
|
|
|
array string
|
Purl for opensource version representative link
|
|
|
|
nicknameList
|
|
|
array string
|
List of alternative names indicating the given Open Source
|
|
|
|
oss_version
|
id
|
|
array object
|
|
|
|
|
|
oss_version_id
|
|
int
|
ID of the given Open Source version (primary key)
|
|
|
|
|
version
|
|
string
|
Version information of the given Open Source (version name)
|
|
|
count
|
|
description
|
|
string
|
Summary description of the given Open Source version (in English)
|
|
|
|
|
description_ko
|
|
string
|
Summary description of the given Open Source version (in Korean)
|
|
|
|
|
attribution
|
|
string
|
Matters requiring separate notification
|
|
|
|
|
license_combination
|
|
string
|
Logical relationship of dual or multiple licenses indicated in declaredLicenseList
(possible values: AND, OR, null) |
|
|
|
|
release_date
|
|
string
|
Release Date
|
|
|
|
|
created_date
|
|
string
|
Data registration date
|
|
|
|
|
modified_date
|
|
string
|
Data Modification Date
|
|
|
|
|
copyright
|
|
string
|
copyright
|
|
|
|
|
declaredLicenseList
|
|
array string
|
Representative license defined in the given Open Source version
|
|
|
|
|
detectedLicenseList
|
|
array string
|
Additional licenses detected aside from declaredLicense in the given Open Source version
|
|
|
|
|
restrictionList
|
|
array string
|
List of restrictions imposed by the given Open Source
|
|
|
count
|
|
|
|
int
|
Total number of the retrieved data
|
|
|
page
|
|
|
|
int
|
Current page number
|
|
|
size
|
|
|
|
int
|
Number of rows per page
|
|
success
|
|
|
|
|
boolean
|
Result of the API call
- false : Failure - true : Success |