L'accès à la ORCID L'API publique nécessite un ensemble d'informations d'identification composé d'un identifiant client et d'un secret client. Ce guide décrit les étapes nécessaires pour obtenir ORCID Identifiants de l'API publique. ORCID les membres n'ont pas besoin de s'inscrire pour l'API publique car leurs informations d'identification de membre peuvent être utilisées à la place. Pour vous inscrire aux identifiants de membre, voir Enregistrer une application cliente.
Les informations d'identification de l'API publique sont liées à celles d'un individu ORCID enregistrer et ne peut être transféré à une autre personne. Vous devrez accepter le Conditions d'utilisation du client public avant la délivrance des justificatifs d'identité.
Les informations d'identification de l'API organisationnelle sont disponibles pour les organisations qui prennent en charge ORCID via un abonnement payant. En savoir plus sur ORCID Adhésion .
Nous recommandons aux développeurs de tester l'API publique dans le serveur de test sandbox avant d'utiliser la version de production.
Nous recommandons aux développeurs de tester l'API publique dans le serveur de test sandbox avant d'utiliser la version de production. Vous trouverez ci-dessous les étapes à suivre pour vous inscrire aux informations d'identification de l'API publique dans les environnements Sandbox et Production.
- Connectez-vous à votre ORCID record:
Serveur de production: https://orcid.org/signin
Serveur de test Sandbox: https://sandbox.orcid.org/signin - Cliquez sur votre nom dans le coin supérieur droit
- Cliquez sur Outils de développement à partir de l'option de menu
Remarque : Pour accéder aux outils de développement, vous devez vérifier votre adresse e-mail. Si vous n'avez pas encore vérifié votre adresse e-mail, vous serez invité à le faire avant de pouvoir vous inscrire pour les informations d'identification de l'API publique - Lisez et acceptez le 'ORCID Conditions d'utilisation des API publiques
- Cliquez sur "S'inscrire pour ORCID Bouton « Informations d’identification de l’API publique ».
Remplir le formulaire de détails de la demande
- Une fois que vous vous êtes enregistré pour vos informations d'identification d'API publique, vous serez redirigé vers les outils de développement (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Vous devez remplir le formulaire de détails de candidature présenté pour enregistrer une nouvelle candidature.
- Nom: Le nom de votre application. Cela sera affiché aux utilisateurs lorsqu'ils accorderont à votre application l'autorisation d'obtenir leur ORCID iD, et il sera affiché dans leur Liste des organisations de confiance. Nous vous recommandons d'utiliser le nom de votre organisation ou service (par exemple, un nom de journal).
- URL de l'application : Le site Web que l'utilisateur peut visiter pour en savoir plus sur votre application. Cela sera également affiché dans leur Liste des organisations de confiance.
- Description de l'application: Informations sur l'application que vous développez et comment vous utiliserez les utilisateurs ORCID identifiant. Cela sera affiché aux utilisateurs sur l'écran OAuth.
L'ajout de Rediriger les URI
Une fois que l'utilisateur a autorisé votre application, il sera renvoyé à un URI que vous spécifiez. Vous devez fournir ces URI à l'avance, sinon vos utilisateurs d'intégration rencontreront une erreur.
- Entrez votre URI de redirection dans la case prévue
- Si vous devez saisir plus d'un URI de redirection, cliquez sur "Ajouter un autre URI de redirection".
Veuillez noter :
- Plus que URI HTTPS sont acceptés en production
- Domaines enregistrés DOIVENT correspondent exactement aux domaines utilisés, y compris les sous-domaines
- Enregistrez tous les URI de redirection dans la mesure du possible. C'est l'option la plus sûre et ce que nous recommandons. Pour plus d'informations sur les URI de redirection, veuillez consulter notre redirection URI FAQ
Enregistrement de votre candidature
Une fois que vous avez rempli le formulaire de candidature et ajouté vos URI de redirection, vous pouvez enregistrer votre candidature.
- Cliquez sur « Enregistrer ma demande et générer mon identifiant client et mon secret »
Vous serez redirigé vers la page des outils de développement qui inclura désormais vos informations d'identification du client de l'API publique
Mise à jour de vos identifiants
Modifier les informations de votre candidature est très simple.
- Modifiez les informations pertinentes, puis cliquez sur "Enregistrer l'application"
Utilisez vos identifiants
Maintenant que vous avez vos identifiants, il est temps de commencer à utiliser le ORCID API publique!
Veuillez noter que nous pouvons transférer vos informations d'identification à l'API membre si vous devenez un ORCID membre dans le futur.
ORCID prend en charge différents quotas d'utilisation d'API et limites de débit en fonction de l'API que vous utilisez.
| API | API anonyme | API publique (enregistrée) | API des membres |
| Limite de débit | 12 req/sec40 rafales/sec | 12 req/sec40 rafales/sec | 24 req/sec40 rafales/sec |
| Quota d'utilisation | 50 XNUMX lectures/jour (Par adresse IP) | 100 XNUMX lectures/jour (par ID client) | Aucun quota d'utilisation |
Demande une seconde sont le nombre de requêtes qui peuvent être faites par seconde.
Eclats il s'agit du nombre de requêtes que nous allons autoriser à être mises en file d'attente avant de les rejeter. Les requêtes dans la file d'attente sont ralenties au rythme des requêtes par seconde. Si vous dépassez le nombre maximal, vous obtiendrez une réponse 503.
Si vous dépassez le quota d'utilisation, vous ne pourrez plus effectuer de nouvelles demandes dans le délai imparti.
S'il vous plaît rappelez-vous que le ORCID L'API publique est gratuite pour une utilisation non commerciale par des particuliers, comme indiqué dans le Conditions d'utilisation des API publiquesPar « non commercial », nous entendons que vous ne pouvez pas facturer de frais de réutilisation pour l’API publique et que vous ne pouvez pas utiliser l’API publique en relation avec un produit ou un service générateur de revenus.
L'utilisation de l'API publique avec les informations d'identification du client permettra à votre intégration d'obtenir un quota d'utilisation plus élevé que l'API anonyme. Veuillez consulter notre guide d'intégration sur la façon d'enregistrer un client API public.
Si vous dépassez régulièrement le quota d'utilisation de l'API pour l'API publique, nous vous recommandons d'envisager de devenir un ORCID membre pour accéder à notre API des membres. Non seulement cela vous permettra d'accéder à une limite de débit plus élevée et à un quota d'utilisation illimité, mais vous pourrez également accéder aux données des parties de confiance dans ORCID enregistre et contribue aux données ORCID enregistrements de vos systèmes institutionnels avec l'autorisation des utilisateurs.