Publiczny interfejs API

Zalecamy, aby programiści przetestowali publiczny interfejs API w serwer testowy piaskownicy przed użyciem wersji produkcyjnej. Poniżej przedstawiono kroki, jak zarejestrować się w celu uzyskania poświadczeń publicznego interfejsu API zarówno w środowisku Sandbox, jak i w środowisku produkcyjnym.

• Zaloguj się na swoje ORCID rekord:
  Serwer produkcyjny: https://orcid.org/signin
  Serwer testowy piaskownicy: https://sandbox.orcid.org/signin
• Kliknij swoje imię w prawym górnym rogu
• Kliknij Narzędzia Deweloperskie z opcji menu
  Uwaga: Aby uzyskać dostęp do Narzędzi dla programistów, musisz zweryfikować swój adres e-mail. Jeśli nie zweryfikowałeś jeszcze swojego adresu e-mail, zostaniesz poproszony o zrobienie tego, zanim będziesz mógł zarejestrować się w celu uzyskania publicznych poświadczeń API
• Przeczytaj i zaakceptuj „ORCID Warunki korzystania z usług publicznych interfejsów API
• Kliknij przycisk „Zarejestruj się ORCID Przycisk „Publiczne dane uwierzytelniające API”.

Wypełnienie formularza szczegółów aplikacji

• Po zarejestrowaniu się w celu uzyskania poświadczeń publicznego interfejsu API nastąpi przekierowanie z powrotem do narzędzi dla programistów (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• Aby zarejestrować nową aplikację, należy wypełnić przedstawiony formularz szczegółów wniosku.
  • Nazwa: Nazwa Twojej aplikacji. Zostanie to wyświetlone użytkownikom, gdy udzielą Twojej aplikacji pozwolenia na ich uzyskanie ORCID iD i będzie wyświetlany w ich Lista zaufanych organizacji. Zalecamy użycie nazwy organizacji lub usługi (np. nazwy czasopisma).
  • URL aplikacji: Witryna, którą użytkownik może odwiedzić, aby dowiedzieć się więcej o Twojej aplikacji. Będzie to również widoczne w ich Lista zaufanych organizacji.
  • Opis aplikacji: Informacje o aplikacji, którą tworzysz i o tym, jak będziesz korzystać z aplikacji użytkownika ORCID ID. Zostanie to wyświetlone użytkownikom na ekranie OAuth.

Dodawanie Identyfikatory URI przekierowania

Gdy użytkownik zatwierdzi Twoją aplikację, zostanie zwrócony do określonego przez Ciebie identyfikatora URI. Musisz podać te identyfikatory URI z wyprzedzeniem, w przeciwnym razie użytkownicy integracji napotkają błąd.

• Wprowadź identyfikator URI przekierowania w wyświetlonym polu
• Jeśli musisz wprowadzić więcej niż 1 identyfikator URI przekierowania, kliknij „Dodaj kolejny identyfikator URI przekierowania”

UWAGA:

• Only Identyfikatory URI HTTPS są akceptowane w produkcji
• Domeny zarejestrowane MUST dokładnie pasują do używanych domen, w tym subdomen
• Jeśli to możliwe, należy w pełni zarejestrować wszystkie identyfikatory URI przekierowań. Jest to najbezpieczniejsza opcja i zalecamy. Aby uzyskać więcej informacji na temat identyfikatorów URI przekierowania, zobacz nasze Często zadawane pytania dotyczące identyfikatora URI przekierowania

Zapisywanie aplikacji

Po wypełnieniu formularza zgłoszeniowego i dodaniu identyfikatorów URI przekierowania możesz zapisać swoją aplikację.

• Kliknij „Zapisz moją aplikację i wygeneruj mój identyfikator klienta oraz klucz tajny”

Nastąpi przekierowanie z powrotem na stronę narzędzi dla programistów, która będzie teraz zawierać poświadczenia klienta publicznego interfejsu API

Aktualizowanie poświadczeń

Dokonywanie zmian w informacjach o aplikacji jest bardzo proste.

• Edytuj odpowiednie informacje, a następnie kliknij „Zapisz wniosek”

Użyj swoich poświadczeń

Teraz, gdy masz już swoje poświadczenia, nadszedł czas, aby zacząć używać ORCID Publiczne API!

Pamiętaj, że możemy przenieść Twoje dane uwierzytelniające do API członka, jeśli zostaniesz członkiem ORCID członek w przyszłości.

Przejrzyj naszą Grupa użytkowników API tematy, aby uzyskać więcej informacji na temat konfigurowania integracji z publicznym interfejsem API. Jednak, aby zmaksymalizować korzyści z ORCID, polecamy przystąpić ORCID jako członek organizacji, która oferuje dostęp do dodatkowych funkcjonalności, osobistą pomoc naszego zespołu integracyjnego i oczywiście wspiera naszą pracę.