Skip to content

Commit

Permalink
9417-update-the-public-api-developer-tools-page-with-new-text (#2361)
Browse files Browse the repository at this point in the history
  • Loading branch information
@leomendoza123
leomendoza123 authored Oct 9, 2024
1 parent 9a3158c commit 2bb07a2
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 39 deletions.
79 changes: 52 additions & 27 deletions src/app/developer-tools/components/terms-of-use/terms-of-use.component.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,50 +8,73 @@ <h2 class="orc-font-body-large" i18n="@@developerTools.gettingStarted">
</h2>

<p i18n="@@developerTools.orcidOffersAnApi">
ORCID offers an API (Application Programming Interface) that allows your
systems and applications to connect to the ORCID registry via
machine-to-machine communication. Using the Public API, your system or
application can:
ORCID offers a free Public API (Application Programming Interface) that allows
your systems and applications to connect to the ORCID registry for
non-commercial use
</p>
<p i18n="@@developerTools.orcidOffersAnApi2">
By registering for Public API Credentials, your system or application can:
</p>

<ul>
<li i18n="@@developerTools.allowUserToSignInto">
Allow users to sign into your system/application with their ORCID username
and password
Allow users to sign into your system/application with their ORCID account
</li>
<li i18n="@@developerTools.getAUserAuthenticated">
Get a user's authenticated ORCID iD
Obtain a user's’ authenticated ORCID iDs
</li>
<li i18n="@@developerTools.retrieveMachineReadable">
Retrieve a machine-readable version of a user's public ORCID record
Read public information from ORCID records in machine-readable format
</li>
<li i18n="@@developerTools.performMachineSearch">
Perform a machine-generated search of the ORCID registry
Search public data in the ORCID Registry
</li>
<li i18n="@@developerTools.obtainHigher">
Obtain a higher usage quota than the ORCID Anonymous API
</li>
</ul>

<p>
<ng-container i18n="@@developerTools.orcidApiResful"
>The ORCID API is RESTful and uses</ng-container
>The ORCID Public API is RESTful and uses</ng-container
>
<a
href="https://oauth.net/2/"
href="https://oauth.net"
rel="noopener noreferrer"
target="_blank"
class="underline"
i18n="@@developerTools.oauth20"
>OAuth 2.0</a
>OAuth</a
><ng-container i18n="@@developerTools.wellEstablishedStandard"
>, a well-established, standard protocol for user-based
permissions.</ng-container
>
>, a well-established, standard protocol for user-based permissions.
</ng-container>
</p>
<p i18n="@@developerTools.publicClientApplicationsAreGranted">
Public Client Applications are granted to individuals and not organizations,
and your Public Client is personal to you (even if you are using it in
Public API Credentials are granted to individuals and not organizations, and
your Public API Credentials are personal to you (even if being used in
connection with your work for an organization).
</p>

<p>
<ng-container i18n="@@developerTools.publicClientApplicationsAreGranted2">
If you need access to an ORCID API for commercial use, need a higher usage
quota, organizational administration of your API credentials, or the ability
to write data to or access Trusted Party data in ORCID records, our
</ng-container>
<a
class="underline"
href="https://info.orcid.org/documentation/features/member-api/"
rel="noopener noreferrer"
target="_blank"
i18n="@@developerTools.memberApi"
>
Member API
</a>
<ng-container i18n="@@developerTools.mayBeMoreAppropriate">
is available to ORCID member organizations.
</ng-container>
</p>

<h2 class="orc-font-body-large" i18n="@@developerTools.additionalResources">
Additional resources
</h2>
Expand All @@ -60,7 +83,7 @@ <h2 class="orc-font-body-large" i18n="@@developerTools.additionalResources">
<li>
<a
class="underline"
href="https://support.orcid.org/hc/en-us/articles/360006897174"
href="https://info.orcid.org/documentation/integration-guide/registering-a-public-api-client/"
rel="noopener noreferrer"
target="_blank"
i18n="@@developerTools.readThePublicApisDocumentation"
Expand All @@ -83,27 +106,30 @@ <h2 class="orc-font-body-large" i18n="@@developerTools.additionalResources">
class="orc-font-body-large no-margin-bottom"
i18n="@@developerTools.orcidPublicClientTermsOfService"
>
ORCID Public Client Terms of Service
ORCID Public APIs Terms of Service
</h2>
<hr />

<p>
<ng-container
i18n="@@developerTools.theOrcidPublicApiAllowsYouToRequestPermission"
>
The ORCID Public API allows you to request permission to receive an
authenticated ORCID iD, to read public information from an ORCID record and
to search public data on the ORCID registry according to the conditions
stated in the
The ORCID Public API is free for non-commercial use by individuals as stated
in the
</ng-container>
<a
href="https://info.orcid.org/public-client-terms-of-service/"
rel="noopener noreferrer"
target="_blank"
class="underline"
i18n="@@developerTools.publicClientTermsOfService"
>Public Client Terms of Service.</a
>Public APIs Terms of Service.</a
>
<ng-container i18n="@@developerTools.byRegisteringForPublicApi">
By “non-commercial” we mean that you may not charge any re-use fees for the
Public API, and you may not make use of the Public API in connection with
any revenue-generating product or service
</ng-container>
</p>

<div class="info" *ngIf="!checked && dirty">
Expand All @@ -128,9 +154,8 @@ <h2 class="orc-font-body-large" i18n="@@developerTools.additionalResources">
[(ngModel)]="checked"
[disabled]="!emailAlreadyVerified"
i18n="@@developerTools.haveReadAndAgreeToTheOrcidPublicClientTermsOfService"
>I have read and agree to the ORCID Public Client Terms of
Service</mat-checkbox
>
>I have read and agree to the ORCID Public APIs Terms of Service
</mat-checkbox>
</p>

<p>
Expand Down
30 changes: 18 additions & 12 deletions src/locale/properties/developer-tools/developer-tools.en.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ developerTools.ressettingYourClientSecret=Resetting your client secret will gene
developerTools.developerTools=Developer tools
developerTools.thisSectionIsIntended=This section is intended for developers who plan to integrate ORCID into their system using the ORCID Public API.
developerTools.gettingStarted=Getting started with the free ORCID Public API
developerTools.orcidOffersAnApi=ORCID offers an API (Application Programming Interface) that allows your systems and applications to connect to the ORCID registry via machine-to-machine communication. Using the Public API, your system or application can:
developerTools.allowUserToSignInto=Allow users to sign into your system/application with their ORCID username and password
developerTools.getAUserAuthenticated=Get a user's authenticated ORCID iD
developerTools.retrieveMachineReadable=Retrieve a machine-readable version of a user's public ORCID record
developerTools.performMachineSearch=Perform a machine-generated search of the ORCID registry
developerTools.orcidApiResful=The ORCID API is RESTful and uses
developerTools.oauth20=OAuth 2.0
developerTools.orcidOffersAnApi=ORCID offers a free Public API (Application Programming Interface) that allows your systems and applications to connect to the ORCID registry for non-commercial use
developerTools.allowUserToSignInto=Allow users to sign into your system/application with their ORCID account
developerTools.getAUserAuthenticated=Obtain a user's’ authenticated ORCID iDs
developerTools.retrieveMachineReadable=Read public information from ORCID records in machine-readable format
developerTools.performMachineSearch=Search public data in the ORCID Registry
developerTools.orcidApiResful=The ORCID Public API is RESTful and uses
developerTools.oauth20=OAuth
developerTools.wellEstablishedStandard=, a well-established, standard protocol for user-based permissions.
developerTools.publicClientApplicationsAreGranted=Public Client Applications are granted to individuals and not organizations, and your Public Client is personal to you (even if you are using it in connection with your work for an organization).
developerTools.publicClientApplicationsAreGranted=Public API Credentials are granted to individuals and not organizations, and your Public API Credentials are personal to you (even if being used in connection with your work for an organization).
developerTools.additionalResources=Additional resources
developerTools.readThePublicApisDocumentation=Read the Public API documentation
developerTools.fillOutMoreAobutTheDifferences=Find out more about the differences between the Public and Member APIs
developerTools.orcidPublicClientTermsOfService=ORCID Public Client Terms of Service
developerTools.theOrcidPublicApiAllowsYouToRequestPermission=The ORCID Public API allows you to request permission to receive an authenticated ORCID iD, to read public information from an ORCID record and to search public data on the ORCID registry according to the conditions stated in the
developerTools.publicClientTermsOfService=Public Client Terms of Service.
developerTools.orcidPublicClientTermsOfService=ORCID Public APIs Terms of Service
developerTools.theOrcidPublicApiAllowsYouToRequestPermission=The ORCID Public API is free for non-commercial use by individuals as stated in the
developerTools.publicClientTermsOfService=Public APIs Terms of Service.
developerTools.youMustAcceptThePublicClientTermsOfService=You must accept the Public Client Terms of Service before you can register for your Public API credentials.
developerTools.haveReadAndAgreeToTheOrcidPublicClientTermsOfService=I have read and agree to the ORCID Public Client Terms of Service
developerTools.haveReadAndAgreeToTheOrcidPublicClientTermsOfService=I have read and agree to the ORCID Public APIs Terms of Service
developerTools.registerForYourOrcidPublicApiCredentials=Register for your ORCID Public API credentials
developerTools.warningDuplicated=You’ve registered for your ORCID Public API credentials
developerTools.addYourApplicationDetails=Add your application details and one or more redirect URIs in the form below. Once these details are saved we’ll generate your client ID and secret so you can start using the Public API right away.
Expand Down Expand Up @@ -76,3 +76,9 @@ developerTools.replaceWithRedirect=REPLACE WITH REDIRECT URI
developerTools.replaceWithOauth=REPLACE WITH OAUTH CODE
developerTools.backToMyRecod=Back to my record
developerTools.exampleCode2=example code
developerTools.orcidOffersAnApi2=By registering for Public API Credentials, your system or application can:
developerTools.obtainHigher=Obtain a higher usage quota than the ORCID Anonymous API
developerTools.publicClientApplicationsAreGranted2=If you need access to an ORCID API for commercial use, need a higher usage quota, organizational administration of your API credentials, or the ability to write data to or access Trusted Party data in ORCID records, our
developerTools.memberApi=Member API
developerTools.mayBeMoreAppropriate=is available to ORCID member organizations.
developerTools.byRegisteringForPublicApi=By “non-commercial” we mean that you may not charge any re-use fees for the Public API, and you may not make use of the Public API in connection with any revenue-generating product or service

0 comments on commit 2bb07a2

Please sign in to comment.