Skip to content

Readme update for generating auth keys #9

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

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

Readme update for generating auth keys #9

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7948cfa
update readme to include new steps to generate api key
Sep 6, 2016
63bd8fc
Fix spelling mistake
froesecom Sep 6, 2016
8a0f7cf
fix grammatical mistake
froesecom Sep 6, 2016
edd20a1
Add syntax highlighting
froesecom Sep 6, 2016
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
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,38 @@ Questions/comments, etc: wiseleyb@gmail.com

Add to your Gemfile:

gem "google_custom_search_api"
`gem 'google_custom_search_api'`

then

bundle install
`bundle install`

## Configure

You need to configure ```GOOGLE_SEARCH_CX``` and ```GOOGLE_API_KEY``` to ```config/initializers/google_cse_api.rb```:
Create the file ```config/initializers/google_cse_api.rb``` and configure ```GOOGLE_SEARCH_CX``` and ```GOOGLE_API_KEY```:

```
GOOGLE_API_KEY = "..."
GOOGLE_SEARCH_CX = "..."
GOOGLE_API_KEY = "key_here"
GOOGLE_SEARCH_CX = "cx_here"
```

Google's API management is confusing at best. At the time of this writing you codes like so:
Google's API management is confusing at best. At the time of this writing you can generate the required codes like so:

### GOOGLE_API_KEY

* Go to [Google Projects](https://console.developers.google.com/project)
* Create a project, open it
* Under `Explore other services` choose `Enable APIs and get credentials like keys`
* Search for `custom search` and click on it
* In the left column click on `Credentials`
* Under `API keys` grab your key. This is your `GOOGLE_API_KEY`
* An API key can be obtained from the [Google Developers Console](https://console.developers.google.com)
* From the `Library` section, click on `Custom Search API` from under `Other popular APIs`
* Enable Custom Search for the project you've created above, by clicking `Enable`
* In order to use the API, you need to create credentials. Do so by clicking "Go to Credentials"
* An API key can be generated while creating your credentials. This is your `GOOGLE_API_KEY`

### GOOGLE_SEARCH_CX

* Go to [Google CSE](https://cse.google.com/cse)
* Create a search engine and click on it
* Under `Setup > Tabs > Basic` find `Details` and click `Search engine ID`
* Create search engine by clicking `Add` and filling in the details and clicking `Create`
* Open the new engine from listing page, or by clicking `Modify your search engine`. Under `Basic` tab find `Details` and click `Search engine ID`
* This is your GOOGLE_SEARCH_CX
* Make sure to add a site under `Sites to search`

Expand Down