CartoDB-SQL-API/README.md
2011-10-07 17:19:02 +01:00

827 B

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.

usage

node cluster.js/app.js [developement,test,production]

for examples of use, see /tests

core requirements

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

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.