Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
psanders committed Aug 29, 2019
1 parent 67be394 commit cba0153
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 5 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The endpoint for the API is:

## Authentication

A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/credentials` endpoint with basic authentication. Use the information from the [User](/configuration/user) resource.
A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/token` endpoint with basic authentication. Use the information from the [User](/configuration/user) resource.

> You must append the `token` to all requests as a query parameter.
Expand Down
10 changes: 7 additions & 3 deletions docs/api/credentials.md → docs/api/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This method gets a token for subsequent API calls.

**URL**

`/credentials`
`/token`

**Method**

Expand All @@ -23,13 +23,17 @@ This method gets a token for subsequent API calls.
**Sample Call**

```json
GET /api/{apiversion}/credentials
GET /api/{apiversion}/token
{

}

HTTP/1.1 200 OK
"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.O7hC-ta225epRQlJZO44WC-l2cWohKnJ8lkmlOQpw8Z_xYiwJ6-qDUhHeJEZH9DmwIwz_jD77sj1kQUkXHsbOg"
{
"status": 200,
"message": "Successful request",
"result": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.TZZ4kp5xIdYzs5RRt6_qVxJcOiLdk1IEHFMBSZ7SRENx6kyVhwfAlm-oeM4L2XFIr4evlTCxKEIKc0fZKwPcjw"
}
```

**Notes**
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ nav:
- Web Console: administration/webconsole.md
- Rest API:
- Overview: api/overview.md
- Credentials: api/credentials.md
- Credentials: api/token.md
- Location:
- create: api/location/create.md
- delete: api/location/delete.md
Expand Down

0 comments on commit cba0153

Please sign in to comment.