Skip to content

Commit

Permalink
GitBook: [master] one page modified
Browse files Browse the repository at this point in the history
  • Loading branch information
Declan O'Connor authored and gitbook-bot committed Jul 6, 2021
1 parent fd4be74 commit be72c1d
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion api/api-documentation.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,45 @@ The Boxtech API is part of the BIC's digital services and you will need to follo

## Authentication

...
The value for Authorization header is: `Basic <credentials>`, where credentials is the Base64 encoding of username and password joined by a single colon `:` eg. `username:password`

Example: `Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`

{% api-method method="post" host="https://boxtech.cif-consulting.co.uk" path="/oauth/token" %}
{% api-method-summary %}
Retrieve Token
{% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %}
{% api-method-request %}
{% api-method-headers %}
{% api-method-parameter name="Authorization" type="string" required=true %}
Base64 encoded username and password as described above.
{% endapi-method-parameter %}
{% endapi-method-headers %}
{% endapi-method-request %}

{% api-method-response %}
{% api-method-response-example httpCode=200 %}
{% api-method-response-example-description %}
Once valid credentials are supplied, a valid access token is returned.
{% endapi-method-response-example-description %}

```
{
"accessToken": "eyJraWQLCJjdbWF6b25hd3MNWGwd8ixowDovA",
"accessTokenExpiresAt": "2021-07-06T12:18:34.164521+00:00",
"access_token": "eyJraWQiOiJPa2DovA"
}
```
{% endapi-method-response-example %}
{% endapi-method-response %}
{% endapi-method-spec %}
{% endapi-method %}

## Open API Documentation and Postman Collection

0 comments on commit be72c1d

Please sign in to comment.