Giter VIP home page Giter VIP logo

echo-api's Introduction

Socialmetrix Echo API

Below you will the documentation for Socialmetrix Echo API. Any doubt or suggestion you can contact us 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:

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.

Once you have the instance, you can setup the base url as follows: http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo

Authentication

Once you have your credentials you MUST include them as part of HTTP HEADER. As an example, using curl:

INSTANCE=socialmetrix-lat
SMXUSER=arjones
TOKEN=e621ef33-62b0-4a44-9c9c-559f40b546cb

curl \
  -H "username: $SMXUSER" \
  -H "token: $TOKEN" \
  -H 'Content-Type: application/json' \
  "http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo/options/brands"

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.

API ready for use

Currently available endpoints are:

Help us make it better

Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please use GitHub issues. Fork these docs and send a pull request with improvements.

echo-api's People

Contributors

arjones avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.