From 2bb07a22ad29685f51f2ffd78d812836b45b9771 Mon Sep 17 00:00:00 2001 From: leomendoza123 Date: Wed, 9 Oct 2024 07:31:50 -0600 Subject: [PATCH] 9417-update-the-public-api-developer-tools-page-with-new-text (#2361) --- .../terms-of-use/terms-of-use.component.html | 79 ++++++++++++------- .../developer-tools.en.properties | 30 ++++--- 2 files changed, 70 insertions(+), 39 deletions(-) diff --git a/src/app/developer-tools/components/terms-of-use/terms-of-use.component.html b/src/app/developer-tools/components/terms-of-use/terms-of-use.component.html index 895fab59eb..91f92fc454 100644 --- a/src/app/developer-tools/components/terms-of-use/terms-of-use.component.html +++ b/src/app/developer-tools/components/terms-of-use/terms-of-use.component.html @@ -8,50 +8,73 @@

- 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 +

+

+ By registering for Public API Credentials, your system or application can:

The ORCID API is RESTful and usesThe ORCID Public API is RESTful and uses OAuth 2.0OAuth, a well-established, standard protocol for user-based - permissions. + >, a well-established, standard protocol for user-based permissions. +

- 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).

+

+ + 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 + + + Member API + + + is available to ORCID member organizations. + +

+

Additional resources

@@ -60,7 +83,7 @@

  • class="orc-font-body-large no-margin-bottom" i18n="@@developerTools.orcidPublicClientTermsOfService" > - ORCID Public Client Terms of Service + ORCID Public APIs Terms of Service

    • @@ -91,10 +114,8 @@

    - 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 target="_blank" class="underline" i18n="@@developerTools.publicClientTermsOfService" - >Public Client Terms of Service.Public APIs Terms of Service. + + 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 +

    @@ -128,9 +154,8 @@

    [(ngModel)]="checked" [disabled]="!emailAlreadyVerified" i18n="@@developerTools.haveReadAndAgreeToTheOrcidPublicClientTermsOfService" - >I have read and agree to the ORCID Public Client Terms of - Service + >I have read and agree to the ORCID Public APIs Terms of Service +

    diff --git a/src/locale/properties/developer-tools/developer-tools.en.properties b/src/locale/properties/developer-tools/developer-tools.en.properties index 100ee8178f..0b913fb28c 100644 --- a/src/locale/properties/developer-tools/developer-tools.en.properties +++ b/src/locale/properties/developer-tools/developer-tools.en.properties @@ -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. @@ -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 \ No newline at end of file