This repository has been archived by the owner on Oct 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
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
fdc1d2d
commit 049bb5f
Showing
3 changed files
with
37 additions
and
1 deletion.
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
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
============= | ||
API Endpoints | ||
============= | ||
|
||
All public FUTURE instances expose a set of dedicated routes that allow to automate the extraction of information. | ||
Each one of these simulate as if a user (in this case an application) entered a query through the user interface, but instead reply with JSON. | ||
|
||
Output | ||
====== | ||
|
||
The most important routes in a FUTURE instance are the **output** endpoints, because they allow to extract information from the server easily. | ||
These are used to obtain URL's or images from the index, or perhaps to get a list of all registered peers in a given instance. | ||
|
||
/_answer | ||
-------- | ||
|
||
.. note:: The parameters for this route are: | ||
|
||
This is the main method to get | ||
+-------+---------+--------+------+ | ||
| Input | | Output | | | ||
+=======+=========+========+======+ | ||
| Name | Type | Name | Type | | ||
+-------+---------+--------+------+ | ||
| query | String | | | | ||
+-------+---------+--------+------+ | ||
| page | Integer | | | | ||
+-------+---------+--------+------+ | ||
| | | | | | ||
+-------+---------+--------+------+ |
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