{"id":19338299,"url":"https://github.com/gbv/orcid-jskos","last_synced_at":"2025-04-23T01:31:24.017Z","repository":{"id":62509399,"uuid":"65366696","full_name":"gbv/orcid-jskos","owner":"gbv","description":"PHP wrapper to access ORCID in JSKOS format","archived":true,"fork":false,"pushed_at":"2017-09-19T12:37:13.000Z","size":12,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-24T08:16:52.148Z","etag":null,"topics":["coli-conc","jskos","library","orcid","service"],"latest_commit_sha":null,"homepage":"http://orcid-jskos.herokuapp.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gbv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-10T08:55:12.000Z","updated_at":"2024-09-02T10:20:07.000Z","dependencies_parsed_at":"2022-11-02T10:16:14.662Z","dependency_job_id":null,"html_url":"https://github.com/gbv/orcid-jskos","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbv%2Forcid-jskos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbv%2Forcid-jskos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbv%2Forcid-jskos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbv%2Forcid-jskos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gbv","download_url":"https://codeload.github.com/gbv/orcid-jskos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250352285,"owners_count":21416464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coli-conc","jskos","library","orcid","service"],"created_at":"2024-11-10T03:16:58.440Z","updated_at":"2025-04-23T01:31:23.710Z","avatar_url":"https://github.com/gbv.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"This repository contains a wrapper written in PHP to access the public [ORCID API](https://members.orcid.org/api) in [JSKOS format](https://gbv.github.io/jskos/) via [Entity Lookup Microservice API (ELMA)](http://gbv.github.io/elma/).\n\n# Background\n\nThe [Open Researcher and Contributor ID (ORCID)](https://orcid.org/) is a code to uniquely identify scientific and other academic authors and contributors. ORCID identifiers are a subset of the International Standard Name Identifier (ISNI) consisting of 16 digits in four groups. The final character may also be an `X`. The identifier is prefixed by `http://orcid.org/` to get an URI. For example:\n\n    0000-0002-2997-7611\n    http://orcid.org/0000-0002-2997-7611\n\nORCID organization provides [a public API](https://members.orcid.org/api) to access and search for ORCID profiles. Access to the API requires credentials in form of a \"client id\" and a \"client secret\" as decribed at \u003chttp://support.orcid.org/knowledgebase/articles/343182\u003e.\n\n# Requirements\n\nRequires the [jskos-php](https://packagist.org/packages/gbv/jskos-php) PHP library.\n\nYou also need client credentials from your ORCID profile to access the ORIC API.\n\n# Installation\n\n~~~bash\ncomposer require gbv/jskos-bartoc\n~~~\n\nThis will automatically create `composer.json` for your project (unless it already exists) and add orcid-jskos as dependency. Composer also generates `vendor/autoload.php` to get autoloading of all dependencies.\n\n# Usage\n\n## Use as library\n\nThe wrapper can be used as instance of class `ORCIDService`, a subclass of `\\JSKOS\\Service`:\n\n~~~php\nrequire 'vendor/autoload.php';\n\n$service = new ORCIDService($client_id, $client_secret);\n~~~\n\nSee [jskos-php-examples](https://github.com/gbv/jskos-php-examples/) for an example how to use the wrapper as part of a larger PHP application.\n\n## Local webservice for testing\n\nTo use as server you also need an implementation of `Http\\Message\\ResponseFactory`, e.g. \n\n    $ composer require php-http/guzzle6-adapter\n\nLocally run the application on port 8080 as following:\n\n    $ composer install\n    $ ORCID_CLIENT_ID=... ORCID_CLIENT_SECRET=... php -S localhost:8080\n\nYou can also put credentials into `credentials.php` as described above.\n\nGiven valid credentials, ORCID profiles can be accessed in JSKOS like this:\n\n* \u003chttp://localhost:8080/?notation=0000-0002-2997-7611\u003e\n* \u003chttp://localhost:8080/?uri=http://orcid.org/0000-0002-2997-7611\u003e\n* \u003chttp://localhost:8080/?search=Dawn%20Wright\u003e\n\n## Webservice via Apache webserver\n\n3. Run `composer install` to download dependencies into directory `vendor`\n\n4. Add a file `credentials.php` with client credentials as following:\n\n    ~~~php\n    \u003c?php\n    define('ORCID_CLIENT_ID', '...');\n    define('ORCID_CLIENT_SECRET', '...');\n    ~~~\n\nYou may add a rule to disallow direct access to all except `index.php`:\n\n    Require all denied\n    \u003cFiles index.php\u003e\n        Require all granted\n    \u003c/Files\u003e\n\n## Webservice at Heroku\n\n3. [Create an app](https://devcenter.heroku.com/articles/creating-apps)\n4. [Configure the app](https://devcenter.heroku.com/articles/config-vars)\n5. [Deploy the app](https://devcenter.heroku.com/articles/git)\n\nIn short:\n\n    $ heroku create\n    $ heroku config:set ORCID_CLIENT_ID=...\n    $ heroku config:set ORCID_CLIENT_SECRET=...\n    $ git push heroku master\n\n# Contributung\n\nBugs and feature request are [tracked on GitHub](https://github.com/gbv/orcid-jskos/issues).\n\nSee `CONTRIBUTING.md` of repository [jskos-php](https://packagist.org/packages/gbv/jskos) for general guidelines.\n\n# Author and License\n\nJakob Voß \u003cjakob.voss@gbv.de\u003e\n\norcid-jskos is licensed under the LGPL license (see `LICENSE` for details).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbv%2Forcid-jskos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgbv%2Forcid-jskos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbv%2Forcid-jskos/lists"}