Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix several typos in README.md #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix several typos in README.md #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f14283
Fix several typos in README.md
tomduhourq Mar 23, 2015
05f376f
Udpate README.md
tomduhourq Mar 23, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
#Socialmetrix Echo API

Below you will the documentation for [Socialmetrix Echo](http://socialmetrix.com/#products) API.
Any doubt or suggestion you can [contact us](mailto:product@socialmetrix.com) directly.
Below you will find the documentation for [Socialmetrix Echo](http://socialmetrix.com/#products) API.
If you have any doubts or suggestions you can [contact us](mailto:product@socialmetrix.com) directly.

##Getting Started

In order to access our API you need to get your credentials consisting of an username and a token, please refer to your account executive to obtain them. They will be like this:
In order to access our API you need to get your credentials consisting of a username and a token; please refer to your account executive to obtain them. They should look like this:

```
Username: arjones
Token: e621ef33-62b0-4a44-9c9c-559f40b546cb
```

##API base URL
Our current API uses your **Echo Instance** as **base url** , your instance is defined at your URL, for example, if your url is: http://socialmetrix-lat.smxecho.com/ your instance is `socialmetrix-lat`.
Our current API uses your **Echo Instance** as **base url**. Your instance is defined at your URL; if, for example, your URL is: http://socialmetrix-lat.smxecho.com/ , then your instance is `socialmetrix-lat`.

Once you have the instance, you can setup the base url as follows:
`http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo`
Expand All @@ -35,9 +35,9 @@ curl \
```

##Rate limiting
During this initial phase, the API isn't rate limited, we want to learn from our customers' consumption patterns to provide an easy to use API. Keep in mind that misuse or abuse will be blocked.
During this initial phase, the API isn't rate limited, we want to learn from our customers' consumption patterns to provide an easy way to use the API. Keep in mind that misuse or abuse will result in blocking.

##API ready for use
##API ready for usage
Currently available endpoints are:

* [/options/brands](sections/brands-metadata.md): Provides information about the **brands metadata**.
Expand Down