API request description improved
This commit is contained in:
@@ -11,7 +11,8 @@ A PID is a string chosen by the publisher and cannot be longer than 16 character
|
|||||||
All API requests must be issued with one special parameter `version` denoting the expected version of the API as a string, e.g. `1.0` (see examples below). You should always put the version of this document as a `version` parameter.
|
All API requests must be issued with one special parameter `version` denoting the expected version of the API as a string, e.g. `1.0` (see examples below). You should always put the version of this document as a `version` parameter.
|
||||||
|
|
||||||
## <a name="registration"></a>NoteHub API Access Request
|
## <a name="registration"></a>NoteHub API Access Request
|
||||||
To register as a publisher and gain access to NoteHub API, please [send](mailto:notehub@icloud.com?subject=NoteHub API Access Request&body=Please add [a] your contact information, [b] short usage explanation and [c] the URL of the resource or it's website.) an email with the following information about you: contact information, short description of what you want to do and an URL of the resource where the API will be used or its website.
|
To register as a publisher and gain access to NoteHub API, please [send](mailto:notehub@icloud.com?subject=NoteHub API Access Request&body=Please add [a] desired PID as a 16 char string [b] your contact information, [c] short usage explanation and [d] the URL of the resource or it's website.) an email with the following information about you: the desired PID, the contact information, short description of what you want to do and an URL of the resource where the API will be used or its website.
|
||||||
|
|
||||||
## Note Retrieval
|
## Note Retrieval
|
||||||
|
|
||||||
A simple `GET` request to the following URL:
|
A simple `GET` request to the following URL:
|
||||||
|
|||||||
Reference in New Issue
Block a user