Clone this wiki locally
###Follow these steps from set-up to deployment and beyond! #####STEP 1: Set Up Locally and Implement 3SCALE - [Getting Started](Getting Started) #####STEP 2: Deploy your Application on Heroku - [Deploy to Heroku](Deploy to Heroku) #####STEP 3: Generate More Data in your Database - [Databases Available](Databases Available) - [Rake Tasks](Rake Tasks) #####STEP 4: Add your own Databases - [XML Parser Documentation](XML Parser Documentation) #####STEP 5: Backup your Database Locally and in Production - [Backup to Amazon S3](Backup to Amazon S3) #####STEP 6: Checkout Addition Features- [Additional Features - More Monitoring - Active Docs](Additional Features)
######[Get Started (Without 3scale)](Getting Started (Without 3scale)) ###What is the UN Data API ####An unofficial API version of the great data made available by the United Nations on the UNDATA site.
The UN Data site has a large database aggregating data from a multitude of important organizations throughout the world. Some of the organizations include the World Health Organization, the International Telecommunications Union, and the United Nations Statistics Division. The problem is that you could only access the data by downloading the files in XML, CSV, and a few other formats. This leads to the problem that if you want to analyze the data, you have to download all the files and parse them into your own database for analyzation and to display the information. We also ran into the issue that between the different organizations, the country names used were not consistent.
We feel that the data on the UN Data site has great value and should be easily accessible to developers. Also, having all the information normalized by country would eventually make it easier to query between different organization’s databases. Our first goal was to get as much of the data as possible into our database and then make more complex queries available to the user. It was important to us to store the data with the minimal amount of manipulation and duplication.
Since beginning this project the UN Data site has released their own API. Checkout the official UNDATA SOAP API using the SDMX standard.
###Why did we do it?
- Make data more easily accessible. The UN has a lot of interesting and useful data and we want developers to be able to access it.
- Provide an example implementation of a RESTful API for learning purposes.
- Showcase 3SCALE’s easy to use authentication and monitoring solutions.
###The API Design
We decided to go with an intuitive RESTful API design. It is important that the API is as easy to use a possible. The main URI format is Organization/Database/Dataset/Country/Records. It serves JSON as default or you can specify the format as XML if preferred.
The hardest part about the project was normalizing all of the country names. In the end we had to make a decision on how to present all of the country names. Since we correlated all the countries together we also added an attribute to the record that stores the name of the country how it was presented in its original database.
###This is an example of how to implement 3scale to your API. This API does all of its authentication using 3SCALE'S API Management system. 3SCALE offers services to authenticate, monitor and rate limit your API. We have two main options to implement the API management system. The first are plugins, which is language specific code package that you add to your code directly. The second option is to use a proxy. The UN Data API uses the plugin option.
The MIT License (MIT) Copyright (c) 2014 3SCALE