This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
public:nnels:nnels_api_docs_v1 [2018/05/15 18:34] jonathan.schatz [Current Testing Server] |
public:nnels:nnels_api_docs_v1 [2019/05/14 17:56] jonathan.schatz |
||
---|---|---|---|
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 ===== | ||
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 ===== |
+ | URL-encode keyword string. | ||
+ | |||
+ | < | ||
+ | GET / | ||
+ | Host: dev.nnels.ca | ||
+ | Authorization: | ||
+ | </ | ||
+ | |||
+ | ===== REPO_ITEMS | ||
==== Specific Repo Item Request example ==== | ==== Specific Repo Item Request example ==== |