Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Crossref Connector
Overview
The Crossref Connector enables seamless integration with scholarly metadata services, providing structured access to works, journals, members, funders, prefixes, types, and licenses. This connector supports searching, filtering, and retrieval of metadata records in JSON format, facilitating discovery, enrichment, and integration into research, publishing, and analytics workflows.
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Crossref Connector.
- listFunders: Retrieves a list of funders in the Crossref funder registry, with support for query, filter, and pagination.
- getFunderById: Retrieves metadata for a specific funder identified by Crossref ID or DOI.
- listJournals: Retrieves a list of journals registered with Crossref, supporting search and filtering
- getJournalByIssn: Retrieves metadata for a specific journal using its ISSN.
- listWorks: Retrieves a list of works (articles, books, proceedings, etc.) with support for queries, filters, sorting, and facets.
- getWorkByDoi: Retrieves metadata for a specific work identified by its DOI.
- getPrefixById: Retrieves metadata for a DOI prefix and associated registration details.
- listMembers: Retrieves a list of Crossref members, including publishers and organizations.
- getMemberById: Retrieves metadata for a specific Crossref member by ID.
- getMemberWorks: Retrieves works deposited by a specific Crossref member.
- listTypes: Retrieves available work types (e.g., journal-article, book, proceedings).
- getTypeById: Retrieves metadata for a specific work type.
- listLicenses: Retrieves a list of licenses and associated work counts.
Detailed Integration Documentation
List Funders
| Action | listFunders |
| Purpose | Retrieves a list of funders in the Crossref funder registry, with support for search, filtering, and pagination. |
| Parameters |
|
| Configuration | Ensure the connector is configured with base URL via CONNECTOR_ENV_CROSSREF_BASE_URL. |
| Output | Returns an array of funder records including ID, name, location, alt-names, and tokens. |
| Workflow Example |
|
Get Funder by ID
| Action | getFunderById |
| Purpose | Retrieves metadata for a specific funder identified by Crossref ID or DOI. |
| Parameters |
|
| Configuration | Same as above. |
| Output | Returns metadata for the requested funder including identifiers, alt-names, and replacement references. |
| Workflow Example |
|
List Journals
| Action | listJournals |
| Purpose | Retrieves a list of journals registered with Crossref. |
| Parameters |
|
| Configuration | Connector must be initialized with Crossref base URL. |
| Output | Returns an array of journal objects including title, publisher, ISSN, subjects, and coverage. |
| Workflow Example |
|
Get Journal by ISSN
| Action | getJournalByIssn |
| Purpose | Retrieves metadata for a journal using its ISSN. |
| Parameters |
|
| Output | Journal record including title, publisher, coverage, subjects, and ISSN details. |
| Workflow Example |
|
List Works
| Action | listWorks |
| Purpose | Retrieves a list of works (articles, books, conference papers, etc.) with support for queries, filters, sorting, and facets. |
| Parameters |
|
| Output | JSON array of works including DOI, title, authors, publication details, and references. |
| Workflow Example |
|
Get Work by DOI
| Action | getWorkByDoi |
| Purpose | Retrieves detailed metadata for a specific work identified by DOI. |
| Parameters |
|
| Output | Detailed work record including title, authors, affiliations, references, publisher, and type. |
| Workflow Example |
|
Get Prefix by ID
| Action | getPrefixById |
| Purpose | Retrieves metadata for a DOI prefix. |
| Parameters |
|
| Output | Metadata including prefix value, associated member, and name. |
| Workflow Example |
|
List Members
| Action | listMembers |
| Purpose | Retrieves a list of Crossref members (publishers, organizations). |
| Parameters |
|
| Output | List of member records including ID, name, prefixes, counts, and coverage. |
| Workflow Example |
|
Get Member by ID
| Action | getMemberById |
| Purpose | Retrieves metadata for a specific Crossref member. |
| Parameters |
|
| Output | Member record including name, prefixes, counts, location, and coverage. |
| Workflow Example |
|
Get Member Works
| Action | getMemberWorks |
| Purpose | Retrieves works deposited by a specific Crossref member. |
| Parameters |
|
| Output | List of works published by the member. |
| Workflow Example |
|
List Types
| Action | listTypes |
| Purpose | Retrieves a list of work types supported by Crossref. |
| Parameters |
|
| Output | Array of work types including ID and label. |
| Workflow Example |
|
Get Type by ID
| Action | getTypeById |
| Purpose | Retrieves metadata for a specific work type. |
| Parameters |
|
| Output | Metadata for the work type including ID and label. |
| Workflow Example |
|
List Licenses
| Action | listLicenses |
| Purpose | Retrieves a list of licenses and associated work counts. |
| Parameters |
|
| Output | List of licenses including license URL and work-count. |
| Workflow Example |
|
Workflow Creation with the Connector
Example Workflow: Scholarly Metadata Discovery and Enrichment
| Discover Target Publishers and Journals |
|
| Harvest Candidate Works |
|
| Enrich and Normalize Metadata |
|
| Resolve Prefixes and Context |
|
| Governance and Quality Control |
|
| Integration and Delivery |
|
This workflow enables applications to perform targeted discovery, metadata enrichment, and reliable delivery of scholarly records, improving catalog quality, reporting accuracy, and integration efficiency.
Pricing
iSolution logo - white - transparent 250 px