Skip to content

Commit a3a2ba2

Browse files
committed
Merge branch 'new-docs' of git.int.sfo01.mml:mxml/api-spec into new-docs
2 parents 03bf386 + 35c053c commit a3a2ba2

File tree

7 files changed

+0
-19
lines changed

7 files changed

+0
-19
lines changed

content/docs/guides/create-a-post.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ title: "Create a Post"
88

99
A [Post](/reference/resources/post) is the microblogging primitive of the App.net API. When a user creates a post, it appears in all of their follower's streams. Posts can have images, links, and annotations but at their simplest, they just contain a piece of text.
1010

11-
* TOC
12-
{:toc}
13-
1411
## Create a post
1512

1613
The easiest way to create a post is to use [one of the API libraries](/docs/libraries).

content/docs/guides/create-an-app.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ title: "Create an App"
66

77
To start accessing parts of the API that require authentication you will need an **access token**. The easiest way to create an access token is to register an app in your [account dashboard](https://account.app.net/settings/).
88

9-
* TOC
10-
{:toc}
11-
129
## Creating an App
1310

1411
1. Start by visiting [account.app.net/settings/](https://account.app.net/settings/). Click on "[Your Apps](https://account.app.net/developer/apps/)" in the bottom left hand corner to go to Your Apps Dashboard.

content/docs/guides/messaging.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ title: "Messaging Overview"
44

55
# App.net Messaging
66

7-
* TOC
8-
{:toc}
9-
107
The App.net Messaging API allows a User to create public, private, semi-private messages between an arbitrary number of users. If you'd like to create public messages that your App.net followers see in their streams, you should [create a post](/reference/resources/post/lifecycle/#create-a-post) with the Stream API. If you need a more flexible messaging solution, the Messaging API is for you.
118

129
Our messaging API is built around 2 central objects: [Channels](/reference/resources/channel/) and [Messages](/reference/resources/message/). If you're familiar with the App.net Stream API, here are some analogies:

content/docs/guides/send-a-broadcast.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ Broadcast Channels are designed to carry low-volume, high-value updates of inter
1010

1111
Just a reminder: while you can do all of this using our API, you don't have to. We have [tools for publishers](https://broadcast.app.net/manage/) to help you quickly get started pulling content in from elsewhere on the web, and you can send them manually via the web or the App.net iOS and Android apps. To get started, **we recommend that you create and set up your broadcast channel with [our web publisher tools](https://broadcast.app.net/manage/)** and only use the API to send broadcasts via the channel you created.
1212

13-
* TOC
14-
{:toc}
15-
1613
## Send a Broadcast
1714

1815
There are a number of parts to each broadcast message. To illustrate, here's a screenshot of a broadcast in the App.net iOS app:

content/docs/libraries.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ title: "API Libraries"
66

77
Using one of the following libraries will help you get up and running with the App.net API in no time. Most of these libraries are maintained by the community.
88

9-
* TOC
10-
{:toc}
11-
129
## Python
1310

1411
pip install adnpy

content/reference/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ title: "App.net API Reference"
55

66
These pages contain the complete specification of how the App.net API works. We try to follow standard practices to make our API easy to use from one of our [client libraries](/docs/libraries/) or from any normal HTTP client.
77

8-
* TOC
9-
{:toc}
10-
118
## Authentication
129

1310
We use the [OAuth 2.0 protocol](http://tools.ietf.org/html/rfc6749) to authenticate clients to the API. There are multiple ways to get a token to a user's account. Please read our [Authentication Overview](/reference/authentication/) to choose the right one for your app.

static/css/style.css

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ code {
151151
}
152152

153153
#markdown-toc {
154-
display: none;
155154
color: #ddd;
156155
margin: 0 0 30px 0;
157156
padding: 10px 0 0 25px;

0 commit comments

Comments
 (0)