jeena/tent.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge pull request #73 from longears/master

Browse source 
Describe the server discovery process in more detail
This commit is contained in:
Jonathan Rudenberg 2012-09-29 13:48:22 -07:00
commit 9a6dd7f4e5
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
content/docs/server-protocol.md
View file

@ -13,7 +13,7 @@ Servers should always be online and be accessible over HTTPS.
### Server Discovery
Users and applications discover Tent servers in one of two ways: HTTP `Link` Headers and HTML `link` tags. Users can provide multiple links to access their Tent server. Multiple links are usually provided in case a particular address becomes unavailble. When multiple links are listed, they should be listed in order of preference from most preferred to least preferred, and contact attempted in the same order.
Users and applications discover Tent servers in one of two ways: HTTP `Link` Headers and HTML `link` tags. Users can provide multiple links to access their Tent server. Multiple links are usually provided in case a particular address becomes unavailable. When multiple links are listed, they should be listed in order of preference from most preferred to least preferred, and contact attempted in the same order.
#### HTTP `Link` Header
@ -44,6 +44,16 @@ with the Tent entity.
<link href="https://tent.titanous.com/profile" rel="https://tent.io/rels/profile" />
```
#### Completing the discovery process
The address in the `Link` header or `link` tag points not to the Tent server itself, but to its `/profile` API method.
To get a list of canonical API roots, do this:
* Perform a `GET` on the profile address using an `Accept: application/vnd.tent.v0+json` header, as specified on the [Server API for Apps](http://tent.io/docs/app-server) page.
* You will get back a JSON dictionary. The list of API roots will be in `json["https://tent.io/types/info/core/v0.1.0"]["servers"]`.
There may be more than one API root in this list. Like multiple `Link` headers, multiple server URLs should be
treated as backups/fallbacks and tried in the order listed. If a post is successfully sent to one of the listed
servers, then the entity is considered to have received it.
### Follow an entity