|
1 | | ---- |
2 | | -title: "Home" |
3 | | ---- |
| 1 | +# Documentation |
4 | 2 |
|
5 | | -# App.net API Documentation |
6 | | - |
7 | | -App.net is a developer-friendly social infrastructure platform. Our API is the primary interface by which developers interact with the platform. The documentation is broken into two parts: these guides and our [full API reference](/reference/). |
8 | | - |
9 | | -## Quick Start |
10 | | - |
11 | | -The App.net API is powerful and flexible -- if you're new to the API, we suggest you start with these guides. |
12 | | - |
13 | | -<div class="promo-block-wrapper ta-center"> |
14 | | - <div class="yui3-g"> |
15 | | - <div class="yui3-u-1-2"> |
16 | | - <div class="promo-block"> |
17 | | - <div class="promo-block-inner"> |
18 | | - <a class="overlay" href="/docs/guides/send-a-broadcast/"></a> |
19 | | - <div class="promo-block-image"></div> |
20 | | - <h3 class="heading-with-hr dark"> |
21 | | - <span>Quick Start: Broadcast</span><hr> |
22 | | - </h3> |
23 | | - <p class="note-style">Send a broadcast with the App.net API.</p> |
24 | | - </div> |
25 | | - </div> |
26 | | - </div> |
27 | | - <div class="yui3-u-1-2"> |
28 | | - <div class="promo-block"> |
29 | | - <div class="promo-block-inner"> |
30 | | - <a class="overlay" href="/reference/authentication/"></a> |
31 | | - <div class="promo-block-image authentication"></div> |
32 | | - <h3 class="heading-with-hr dark"> |
33 | | - <span>Quick Start: Authentication</span><hr> |
34 | | - </h3> |
35 | | - <p class="note-style">Learn how to make authenticated requests to the API.</p> |
36 | | - </div> |
37 | | - </div> |
38 | | - </div> |
39 | | - </div> |
40 | | -</div> |
41 | | - |
42 | | -## Notable API features |
43 | | - |
44 | | -### Identity & Authentication |
45 | | - |
46 | | -Use App.net's identity layer to authenticate users and populate user profiles. For more information, see the [Authentication reference](/reference/authentication/) and [User reference](/reference/resources/user/). |
47 | | - |
48 | | -### Social Graph |
49 | | - |
50 | | -App.net has a asymmetrical (follower-following) social graph which can be used to solve the "cold start" problem when a user signs into your app. The [Following reference](/reference/resources/user/following/) has more details. |
51 | | - |
52 | | -### Messaging |
53 | | - |
54 | | -Channels are like chat rooms. They're a time ordered series of messages that can be public, private, or restricted to a group of App.net users. The messages inside of channels can take advantage of App.net files, places, and anything else the API provides. [Chat rooms](https://directory.app.net/app/145/patter/), [Broadcasts](http://blog.app.net/2013/11/21/announcing-app-net-broadcast/), and private messages are all built on top of [App.net Messaging](/docs/guides/messaging/). |
55 | | - |
56 | | -### Places |
57 | | - |
58 | | -App.net has a location database that can be integrated with your app. This allows you to add location to Posts or Message to enable location aware apps. See the [Places reference](/docs/references/resources/places/) for more information. |
59 | | - |
60 | | -### Annotations |
61 | | - |
62 | | -Annotations are machine readable metadata that can be attached to most App.net objects (posts, messages, users, and more). They power [checkins](https://alpha.app.net/browse/checkins/), [photos](https://alpha.app.net/browse/photos/) and other rich posts on App.net. See the [Annotations introduction](/docs/references/resources/meta/annotations/) to get started. |
63 | | - |
64 | | -### Files |
65 | | - |
66 | | -App.net gives each user space to store and share files. These files can be shared publicly, attached to posts, or sent as a private message to a friend. All App.net apps share the same file storage space so if a new photo or video app comes along, you can check it out and not have to worry about migrating all your old data. See the [Files reference](/docs/references/resources/files/) for more information. |
67 | | - |
68 | | - |
69 | | -## Tracking news and announcements |
70 | | - |
71 | | -To see the latest updates to the API, follow [@adnapi](http://alpha.app.net/adnapi). You may also want to subscribe to the [App.net blog](https://broadcast.app.net/26283/appnet-blog/) for general news and the [App.net API Updates](https://broadcast.app.net/24368/appnet-api-updates/) Broadcast channel for developer related news. |
72 | | - |
73 | | -## Getting help and providing feedback |
74 | | - |
75 | | -There are numerous ways for developers to get help utilizing the platform and to provide feedback. |
76 | | - |
77 | | -* Developers (including App.net staff) are often chatting in the [Developer Channel](http://patter-app.net/room.html?channel=1383). |
78 | | -* For developer inquiries about the API, our Terms of Service, letting us know about something you're working on, etc., email [developers@app.net](mailto:developers@app.net). |
79 | | -* For general inquiries about account/service related issues, email [support@app.net](mailto:support@app.net). |
80 | | -* In addition to the above, you can report bugs and provide feedback on the API using the [issue tracker](https://github.com/appdotnet/api-spec/issues). |
81 | | -* This documentation is open source. If you find an error or something that's unclear, let us know with a pull request or issue on the [Github repo for the documentation](https://github.com/appdotnet/api-spec/). |
82 | | - |
83 | | -## Your hosts |
84 | | - |
85 | | -* [Bryan Berg](http://ber.gd) ([@berg](https://alpha.app.net/berg), [bryan@app.net](mailto:bryan@app.net)) |
86 | | -* Mark Thurman ([@mthurman](https://alpha.app.net/mthurman), [mthurman@app.net](mailto:mthurman@app.net)) |
87 | | -* [Alex Kessinger](http://alexkessinger.net) ([@voidfiles](https://alpha.app.net/voidfiles), [alex@app.net](mailto:alex@app.net)) |
88 | | -* Brian Armstrong ([@barmstrong](https://alpha.app.net/barmstrong), [barmstrong@app.net](mailto:barmstrong@app.net)) |
| 3 | +Root of docs is [here](/docs/). |
0 commit comments