-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9aa7814
commit 2101ff9
Showing
1 changed file
with
1 addition
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,4 @@ | ||
# API | ||
|
||
nmrXiv infrastructure supports API through which software developers can interact with the data programmatically. Postman tool is used to document how nmrXiv API should be used, methods, status, and error codes supported. | ||
The infrastructure of nmrXiv facilitates API access, enabling software developers to interact with the data programmatically. The documentation for nmrXiv API, including information on methods, status, and supported error codes, is provided using [Swagger](https://swagger.io/). For detailed insights into API usage, please refer to our [Swagger documentation](https://nmrxiv.org/api/documentation). | ||
|
||
Postman allows you to publish documentation quickly and easily. Postman automatically pulls your sample requests, headers, code snippets, etc., to populate your documentation page with dynamic examples and machine-readable instructions so you can easily share your API with the rest of the world. | ||
|
||
## [nmrXiv APIs](https://www.postman.com/nmrxiv-jena/workspace/nmrxiv/request/17173369-2ef7d5a8-0121-418b-8762-cc47d7a5b7cd) | ||
|
||
<img src="/img/postman.png"/> | ||
|
||
<br/><br/> | ||
If you are interested in specific endpoints, check out the following quick links: | ||
|
||
- [Authentication and Authorisation](https://www.postman.com/nmrxiv-jena/workspace/nmrxiv/collection/17173369-f372ec15-9b92-4902-8844-b129ab0c17d1?ctx=documentation) | ||
- [Projects/Studies/Dataset](https://www.postman.com/nmrxiv-jena/workspace/nmrxiv/collection/17173369-b00475c3-6171-4e58-97ab-cb88b3ac4c59?ctx=documentation) | ||
- [Bioschemas](https://www.postman.com/nmrxiv-jena/workspace/nmrxiv/folder/17195598-561a4bcc-7c84-4669-b245-c8416dfc8e90?ctx=documentation) |