Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
public:nnels:nnels_api_docs_v1 [2018/04/24 14:35] jonathan.schatz [Specific Repo Item Request example] |
public:nnels:nnels_api_docs_v1 [2024/05/08 22:04] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== NNELS API v1.1 Documentation ====== | + | ====== NNELS API v1.x Documentation ====== |
| Version 0.5 used Services and Services Views.\\ | Version 0.5 used Services and Services Views.\\ | ||
| Version 1.x uses RESTful framework.\\ | Version 1.x uses RESTful framework.\\ | ||
| \\ | \\ | ||
| - | **Resources exposed**: | ||
| - | * Auth - / | ||
| - | * Users - /users/ | ||
| - | * Repo_Items - / | ||
| - | * FileResources - / | ||
| - | * Basic Search - / | ||
| ===== Current Testing Server ===== | ===== Current Testing Server ===== | ||
| |Host|dev.nnels.ca| | |Host|dev.nnels.ca| | ||
| |Base Endpoint|api| | |Base Endpoint|api| | ||
| - | |Example|https:// | + | |Example|https:// |
| ===== Notes ===== | ===== Notes ===== | ||
| Line 20: | Line 14: | ||
| * Refresh against < | * Refresh against < | ||
| * If receiving uid 0 back from a specific user request, this means your access token expired. | * If receiving uid 0 back from a specific user request, this means your access token expired. | ||
| + | |||
| + | **Discover Resources and their versions** | ||
| + | |||
| + | To discover a list of available resources and the latest version for each, issue: | ||
| + | < | ||
| + | GET /api/ | ||
| + | Host: [:current host] | ||
| + | </ | ||
| ===== AuthN ===== | ===== AuthN ===== | ||
| Line 135: | Line 137: | ||
| " | " | ||
| " | " | ||
| - | " | + | " |
| } | } | ||
| } | } | ||
| </ | </ | ||
| - | ===== SEARCH | + | ===== BASIC SEARCH ===== |
| - | Coming soon. | + | |
| - | ===== REPO_ITEMS ===== | + | ==== Keyword Search v1.1 ===== |
| - | Note: Uses UUID primarily, not NID\\ | + | URL-encode keyword string. |
| + | |||
| + | < | ||
| + | GET / | ||
| + | Host: dev.nnels.ca | ||
| + | Authorization: | ||
| + | </ | ||
| + | |||
| + | ===== REPO_ITEMS | ||
| ==== Specific Repo Item Request example ==== | ==== Specific Repo Item Request example ==== | ||
| Line 153: | Line 163: | ||
| </ | </ | ||
| - | **With UUID (uuid)** | + | **Alternate load by UUID (uuid)** |
| < | < | ||
| - | GET / | + | GET / |
| Host: dev.nnels.ca | Host: dev.nnels.ca | ||
| access-token: | access-token: | ||
public/nnels/nnels_api_docs_v1.1524605710.txt.gz · Last modified: 2018/04/24 14:35 by jonathan.schatz
