m ((username removed) (log details removed)) |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:How to import the Share-VDE API Collection: the PostMan Collection}} | |||
The following link: https://www.getpostman.com/collections/bd55c075725e90383779 points to a collection of API examples that can be imported in PostMan<ref><nowiki>https://www.postman.com</nowiki></ref> using the steps described below. | The following link: https://www.getpostman.com/collections/bd55c075725e90383779 points to a collection of API examples that can be imported in PostMan<ref><nowiki>https://www.postman.com</nowiki></ref> using the steps described below. | ||
The examples you'll find in the collection target the | The examples you'll find in the collection target the UAT environment. | ||
====Install Postman / access Postman web application==== | ====Install Postman / access Postman web application==== | ||
| Line 18: | Line 19: | ||
Although it is possible to create also a "public" workspace, at this stage we don't recommend to create that for hosting the Share VDE API calls. | Although it is possible to create also a "public" workspace, at this stage we don't recommend to create that for hosting the Share VDE API calls. | ||
====Import the sample collection==== | ====Import the sample collection==== | ||
Once the workspace has been created click on the "Import" link that appears on the top of the explorer panel[[File:Postman "Import" menu item .png|none|thumb|551x551px|link=https://wiki.share-vde.org/wiki/File:Postman_%22Import%22_menu_item_.png]]The import dialog should appear. You need to select the "Links" tab and put this link https://api.postman.com/collections/18463300-129f4856-9257-4b16-85bf-7b4920af482f?access_key=PMAT-01HJ5XM822ZT5CBC29YTYC6S1Z in the text box, as illustrated in the following picture.[[File:import.png|none|thumb|753x753px | Once the workspace has been created click on the "Import" link that appears on the top of the explorer panel[[File:Postman "Import" menu item .png|none|thumb|551x551px|link=https://wiki.share-vde.org/wiki/File:Postman_%22Import%22_menu_item_.png]]The import dialog should appear. You need to select the "Links" tab and put this link https://api.postman.com/collections/18463300-129f4856-9257-4b16-85bf-7b4920af482f?access_key=PMAT-01HJ5XM822ZT5CBC29YTYC6S1Z in the text box, as illustrated in the following picture.[[File:import.png|none|thumb|753x753px]]Once confirmed, in the left explorer pane you should see the examples. Just click on one of them and it executes the request, including the authentication workflow.[[File:collection imported.png|none|thumb|745x745px]] | ||
====Collection overview==== | ====Collection overview==== | ||
The examples have been divided in several subfolders, listed and described as follows. | The examples have been divided in several subfolders, listed and described as follows. | ||
| Line 26: | Line 27: | ||
======Content Negotiation====== | ======Content Negotiation====== | ||
The content negotiation capabilities, as described [[ | The content negotiation capabilities, as described [[ShareDoc:Content Negotiation|in this page]]. Note there are three sub-folders that illustrate the three different ways to negotiate / request a given format. | ||
======Provenance API====== | ======Provenance API====== | ||
| Line 45: | Line 46: | ||
*'''Sample Query Template''': a query example with variables | *'''Sample Query Template''': a query example with variables | ||
*'''Sample Schema Request''': a schema query example | *'''Sample Schema Request''': a schema query example | ||
<references /> | ­<references /> | ||
__FORCETOC__ | __FORCETOC__ | ||
Latest revision as of 08:43, 28 May 2024
The following link: https://www.getpostman.com/collections/bd55c075725e90383779 points to a collection of API examples that can be imported in PostMan[1] using the steps described below.
The examples you'll find in the collection target the UAT environment.
Install Postman / access Postman web application
Postman is available in several shapes: as a standalone or web application. The interface is pretty similar in both shapes.
You should
- install the application in your machine (not needed if you prefer the web application)
- create an account
- login
Create a workspace
The very first time you log into the application you should create a new workspace. That can be done using the "Workspace" menu item. The workspace can be a team or personal workspace.
Although it is possible to create also a "public" workspace, at this stage we don't recommend to create that for hosting the Share VDE API calls.
Import the sample collection
Once the workspace has been created click on the "Import" link that appears on the top of the explorer panel
The import dialog should appear. You need to select the "Links" tab and put this link https://api.postman.com/collections/18463300-129f4856-9257-4b16-85bf-7b4920af482f?access_key=PMAT-01HJ5XM822ZT5CBC29YTYC6S1Z in the text box, as illustrated in the following picture.
Once confirmed, in the left explorer pane you should see the examples. Just click on one of them and it executes the request, including the authentication workflow.
Collection overview
The examples have been divided in several subfolders, listed and described as follows.
REST
The folder contains the examples related to the REST API.
Content Negotiation
The content negotiation capabilities, as described in this page. Note there are three sub-folders that illustrate the three different ways to negotiate / request a given format.
Provenance API
ShareVDE entities are the result of merging data coming from several sources. As a consequence of that, an entity provides a set of attributes that have been originally contributed by one or more sources. We call those sources "provenances".
By means of the Provenance API, the requestor can list the provenances that contributed to a given entity.
Core Entities (e.g. Opus, Work, Instance)
There is a folder for each type of entity managed in ShareVDE. API calls have been divided by entity for simplifying and better organising them.
Varia
- OpenAPI Specs: the request produces a JSON that can be imported in tools like https://editor.swagger.io/
GraphQL
The folder contains the examples related to the GraphQL API. Each folder includes specific entities; in addition there are two requests that can be used as templates:
- Sample Query Template: a query example with variables
- Sample Schema Request: a schema query example
- ↑ https://www.postman.com
