Catalog of Web Services
The online Catalog of Web Services is a common place where API documentation is located.
In this framework, you can read, copy and test various methods and adapt them to your needs.
Table of contents
- Header
- Parameters
- Responses
- Schemas
|
1. Header
The Header of an individual PANTHEON API example contains information about which operation method is being used, API endpoint relative to the base URL, the description of an action shown and a working example of a query:
- Operation methods used
- Endpoint
- Description
- Example of a query
Operation methods in PANTHEON API:
|
|
Retrieves data from the server.
|
|
|
Creates new records in the database or retrieves data from the server.
|
|
|
Updates existing records.
|
2. Parameters
In the Parameters, an example of a query without values is shown.
By clicking the Try it out button, the query editor opens and you can prepare your own queries.
After the data or query is entered, you can execute the method by selecting the Execute button. If you want to escape the editor, select the Cancel button.
2.1 Parameters field
In some APIs, data can be also entered in the Parameters field:
2.1.1 Input field
In the Parameters field Ident, you can enter your item.
2.1.2 Request body
In the Request body, you can enter your query or edit the sample query.
3. Responses
In the Responses, results are shown after the query is executed.
Responses include:
- cURL
- Request URL
- Server response
3.1 cURL
Contains a cURL command-line tool with the parameters of the executed query. With the copy to clipboard icon in the right bottom corner, you can easily copy the cURL line to clipboard.
3.2 Request URL
Contains the URL that was used by the method. It consists of a HTTPS method, a base URL and an endpoint or resource URI.
3.3 Server response
Shows the results of a successfully executed query.
Response headers contain information about the content type, charset, time and server of the executed query.
In the response body, results are presented in the JSON format. They can be copied to clipboard or downloaded as a .json file by selecting the corresponding button in the bottom right corner.
The codes displayed in the Responses show the status of the executed query.
|
200
|
Success: successfully executed.
|
|
500
|
Error: description of an error.
|
4. Schemas
Schemas contain information about objects data structure.
A specific schema provides a description of the specified object.
