cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6d1cf120c7
CartoDB-SQL-API/README.md
Sandro Santilli 6d1cf120c7 wrap to 80 cols
2012-03-13 19:32:01 +01:00

886 B
Raw Blame History

SQL API for cartodb.com

Provides a nodejs based API for running SQL queries against CartoDB.

  • Users are authenticated over OAuth. Also provides ability to make public "SELECT" only calls.
  • OAuth requests to this API should always be made over SSL.

core requirements

  • pg_bouncer
  • postgres
  • redis
  • node v0.4.8+
  • npm

usage

Make sure redis is running and knows about active cartodb user.

node [cluster.js|app.js] [developement|test|production]

for examples of use, see /tests

dependencies

npm install

tests

npm test-unit
npm test-acceptance

make sure you have setup your database connections in /config, and have the correct databases and keys setup in redis. You'll at least need to set redis with HSET rails:oauth_tokens:1 user_id 1 for the acceptance tests.