Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Commit

Permalink
doc(getObject): Add documentation for the getObject endpoint (#386)
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoErcolanelli authored and redox committed Feb 14, 2017
1 parent 30e4b30 commit 4195bb7
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/source/rest.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ In order to guarantee a very high-availability, we recommend to implement a retr
- then `https://places-2.algolianet.com`,
- then `https://places-3.algolianet.com`.

### Endpoint
### Endpoints

#### Search

To search using the Algolia Places REST API, you need to target the `/1/places/query` endpoint with a `POST` request.

Expand All @@ -22,6 +24,17 @@ $ curl -X POST 'https://places-dsn.algolia.net/1/places/query' --data '{"query":

**Note:** The relative path prefix `/1/` indicates that we are currently using version 1 of the API.

#### Get by objectID

To get an Algolia Places Record using the REST API, you need to target the `/1/places/{objectID}` endpoint with a `GET` request.
Replace `{objectID}` by the objectID you whish to query.

```bash
$ curl -X GET 'https://places-dsn.algolia.net/1/places/111781_17807753'
```

**Note:** The relative path prefix `/1/` indicates that we are currently using version 1 of the API.

### Authentication

If you're using the authenticated version of our API (higher rate-limits), you'll need to authenticate yourself. This is done via the following HTTP headers:
Expand Down

0 comments on commit 4195bb7

Please sign in to comment.