Lets you create authors groups and edit authors in them.
Create a new authors group.
https://stage.prophy.ai/api/external/authors-group/create/
| Field | Description |
|---|---|
|
group_name
string
required
|
The name for the new authors group |
|
owner_team
string
required
|
The name of the team in your organization that will have the owner rights for the authors group. The team must be already created through the user interface. |
|
editor_teams
array of strings
required
|
The names of the teams in your organization that will have the editor rights for the authors group. The teams must be already created through the user interface. Provide an empty list if no team would have editor rights. |
|
viewer_teams
array of strings
required
|
The names of the teams in your organization that will have the viewer rights for the authors group. The teams must be already created through the user interface. Provide an empty list if no team would have viewer rights. |
curl -X POST "https://stage.prophy.ai/api/external/authors-group/create/" \
-H "X-ApiKey: <API Key>" \
-H "Content-Type: application/json" \
-d '{
"group_name": "2023 Astrophysics Experts",
"owner_team": "Authors groups administrators",
"editor_teams": [],
"viewer_teams": ["Quantum Dynamics Review", "Particle Physics Letters"]
}'
| Field | Description |
|---|---|
|
authors_group_id
integer
|
ID of the created authors group in the Prophy database |
{
"authors_group_id": 162
}
Get the linked author of the author from group.
https://stage.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/
| Parameter | Description |
|---|---|
|
group_id
integer
|
The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface. |
|
client_id
string
|
The client-side ID identifier of the specific author from group. This was used when adding the author to the group. |
curl -X GET "https://stage.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/" \
-H "X-ApiKey: <API Key>"
| Field | Description |
|---|---|
|
author
nullable object
|
Linked author of the author from group. Contains null if the author from group has no linked author.
|
| Field | Description |
|---|---|
|
prophy_url
string
|
A link to the linked author profile in Prophy |
|
name
string
|
A name of the linked author |
|
articles_count
integer
|
Number of published articles by the linked author |
|
h_index
integer
|
H-index of the linked author |
|
last_articles
array of objects
|
Last three articles published by the linked author |
| Field | Description |
|---|---|
|
prophy_url
string
|
A link to article in Prophy |
|
title
string
|
Article title |
|
year
integer
|
Article publication year |
{
"author": {
"prophy_url": "https://stage.prophy.ai/author/13096/John-Smith/",
"name": "John Smith",
"articles_count": 143,
"h_index": 30,
"last_articles": [
{
"prophy_url": "https://stage.prophy.ai/article/7023-Superconductivity-in-two-dimensional-materials/",
"title": "Superconductivity in two-dimensional materials",
"year": 2023
},
{
"prophy_url": "https://stage.prophy.ai/article/7024-Manipulation-of-spin-textures-by-unconventional-spin-torques/",
"title": "Manipulation of spin textures by unconventional spin torques",
"year": 2023
},
{
"prophy_url": "https://stage.prophy.ai/article/7025-Probing-new-physics-with-displaced-vertices-muon-tracker-at/",
"title": "Probing new physics with displaced vertices: muon tracker at CMS",
"year": 2022
}
]
}
}
Create or update an author from group in a specific group
https://stage.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/
| Parameter | Description |
|---|---|
|
group_id
integer
|
The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface. |
|
client_id
string
|
The client-side ID identifier of the specific author from group. This was used when adding the author to the group. |
| Field | Description |
|---|---|
|
name
string
required
|
The name for the author from group |
|
emails
nullable list of strings
|
List of author's emails |
|
orcids
nullable list of strings
|
List of author's ORCIDs |
|
articles
nullable list of strings
|
A list of an articles published by the author. Will be used in disambiguation process. This can be a list of DOIs or a list of titles. |
|
<custom_field_api_id>
any
|
Include custom field api key and value into request body to add it for the author:
You can obtain these custom field Values should be formatted according to the field's
|
curl -X POST "https://stage.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/" \
-H "X-ApiKey: <API Key>" \
-H "Content-Type: application/json" \
-d '{
"name": "John Smith",
"emails": ["[email protected]", "[email protected]"],
"orcids": ["0000-0000-0000-0001"],
"affiliations": [
"University of Copenhagen, Denmark",
"Ecole Polytechnique Federale de Lausanne, Switzerland"
],
"articles": [
"Exploring the Quantum Critical Behavior of Strongly Correlated Electron Systems",
"From Quantum Materials to Quantum Technologies"
],
"06571c47-4f2f-7262-8000-4cb0b7d099f0": 10.5,
"06571c33-7416-7c61-8000-1ace086d8afe": "UK",
"06571c48-9385-7ab3-8000-d77c308cb3e8": "2024-02-01",
"065aa2d4-2448-73ec-8000-1a4a0c37f008": "065aa2d4-246e-79bb-8000-8c9b70efe4dc",
"065aa2d5-9626-796a-8000-126817d64cd5": ["065aa2d5-963a-78e7-8000-621a4e9399b4", "065aa2d5-963a-7d18-8000-56ceb1516000"]
}'
| Field | Description |
|---|---|
|
ok
boolean
|
Indicates whether the operation was successful. In case of failure, the API will return a non-200 status code. |
{
"ok": true
}