Skip to content
This repository was archived by the owner on Aug 5, 2021. It is now read-only.

Commit 0dbfac7

Browse files
author
Kevin Richter
committed
Smal fixes
1 parent f4dcb1e commit 0dbfac7

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

source/v1/index.html.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,11 @@ print_r(json_decode((string) $response->getBody()));
112112
113113
The Maps4News API is an OAuth2 API. We support implicit and password flows.
114114

115-
<aside class="notice">
116-
You must have a valid client registered with us to be able to use the API. Clients are currently on request.
117-
</aside>
115+
<aside class="notice">You need a OAuth Client or Personal Access Token to use the API.</aside>
118116

119117
# API
120118

121-
## Introduction
119+
To register an OAuth Client or Personal Access Token, please [log into the API](https://api.beta.maps4news.com) register one via your account settings.
122120

123121
Have a look at our [OpenAPI spec](https://api.beta.maps4news.com/docs), the spec contains all the endpoints, info about how resources look and what each endpoint requires you to submit.
124122

@@ -153,7 +151,6 @@ All JSON responses from the API is wrapped in a base object.
153151

154152
Be sure to include an `Accept: application/json` header, otherwise errors like `401`, `403` & `404` will either return HTML or redirect you to the login page.
155153

156-
157154
## Query Parameters
158155

159156
The API has a few query parameters available that you can use to help find the resources you need.
@@ -179,6 +176,8 @@ By default the API returns 12 items per page and defaults to page 1.
179176

180177
The number of items per page can be increased to a maximum of 50 items.
181178

179+
<br/><br/><br/><br/><br/><br/>
180+
182181
### Sorting
183182

184183
> Sort ID Descending and Name Ascending
@@ -382,7 +381,6 @@ api.authenticate().then(function() {
382381
</body></html>
383382
```
384383

385-
386384
This will create a pop-up window containing the login page.
387385
Once the pop-up redirects back to the callback it will resolve the promise.
388386
The callback can be an empty page hosted on the same domain.
@@ -454,7 +452,6 @@ This means that for example `place_name` will be transformed into `placeName`.
454452

455453
Async methods return a `Promise` this means that both `then/catch` and `await/async` syntax are supported.
456454

457-
458455
## Getting a resource
459456

460457
> Fetch resource and all its properties

0 commit comments

Comments
 (0)