Skip to content

Commit 3720310

Browse files
authored
Update changelog readme for Oauth (iZettle#147)
* Updated CHANGELOG and README with changes about get-started and OAuth flow.
1 parent 524d4c9 commit 3720310

File tree

7 files changed

+19
-12
lines changed

7 files changed

+19
-12
lines changed

CHANGELOG.adoc

+7-2
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,19 @@ Each log entry uses the following tags:
77
- For API changes and the corresponding documentation changes, the log is tagged with the name of the changes API. For example, `OAuth API`.
88
- For documentation changes that are editorial and are not introduced by any API change, the log is tagged with `Editorial changes`.
99
10-
.**February 3, 2022** `Inventory API`
10+
.**February 3, 2022** `Inventory API` `OAuth API` `Get started`
1111
[%collapsible]
1212
====
13-
**Extended documentation with these additions:**
13+
**Extended Inventory API documentation with these additions:**
1414

1515
- Overview of Inventory API.
1616
- Concept description - how inventories work.
1717
- User guides for managing locations, tracking, inventory balances, and low stock levels.
18+
19+
**Added how to get started with Zettle APIs:**
20+
21+
- A user guide for signing up for a developer account.
22+
- Users guides for setting up authorisation flows.
1823
====
1924
2025
.**January 18, 2022** `OAuth API` `Editorial changes`

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,12 @@ All API incidents are recorded in [Incidents](incidents.md).
3838

3939
For common questions about the APIs, see [Frequently Asked Questions](faq.adoc).
4040

41-
## Credentials
41+
## Get started
42+
Before you start to build an app with Zettle, you need to [sign up for a developer account at Zettle Developer Portal](get-started/user-guides/sign-up-for-a-developer-account.md).
4243

43-
Apply for API credentials on [Zettle Developer Portal](https://developer.zettle.com/register).
44+
When you have a developer account, choose one of the following app types based on your needs:
45+
* To build a self-hosted app that is hosted by merchants individually, [create a self-hosted app](oauth-api/user-guides/create-an-app/create-a-self-hosted-app/create-a-self-hosted-app.md).
46+
* To build a partner-hosted app that is hosted by you as an integrator, [create a partner-hosted app](oauth-api/user-guides/create-an-app/create-a-partner-hosted-app.md).
4447

4548
## Get help
4649
Contact our [Integrations team](mailto:[email protected]) for more information.

get-started/user-guides/sign-up-for-a-developer-account.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before you start to build an app with Zettle, you need to sign up for a Zettle d
1919
After that, you will receive a welcome email from Zettle with the Developer Platform Agreement. Now you're ready to start building with Zettle.
2020

2121
## Next task
22-
* To build a self-hosted app that is hosted by merchants individually, [create a self-hosted app](../../oauth-api/user-guides/create-an-app/create-a-self-hosted-app).
22+
* To build a self-hosted app that is hosted by merchants individually, [create a self-hosted app](../../oauth-api/user-guides/create-an-app/create-a-self-hosted-app/create-a-self-hosted-app.md).
2323
* To build a partner-hosted app that is hosted by you as an integrator, [create a partner-hosted app](../../oauth-api/user-guides/create-an-app/create-a-partner-hosted-app.md).
2424

2525
## Related API reference

oauth-api/user-guides/create-an-app/create-a-partner-hosted-app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A partner-hosted app is hosted by you as an integrator. To authorise, the app us
55
In an authorisation code grant flow, you use a temporary authorisation code to exchange for an access token from the authorisation server. A temporary authorisation code is generated from the authorisation server using API credentials. API credentials include a client secret and client ID.
66

77
To authorise your app using authorisation code grant, you need to get API credentials for the app by creating an app in your Dashboard on the [Developer Portal](https://developer.zettle.com/).
8-
> **Note:** If you want to build a self-hosted app that will be hosted by merchants, [create a self-hosted app](create-a-self-hosted-app).
8+
> **Note:** If you want to build a self-hosted app that will be hosted by merchants, [create a self-hosted app](create-a-self-hosted-app/create-a-self-hosted-app.md).
99
1010
* [Prerequisites](#prerequisites)
1111
* [Get API credentials for a new app](#get-api-credentials-for-a-new-app)

oauth-api/user-guides/create-an-app/create-a-self-hosted-app/create-a-self-hosted-app.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ Create a self-hosted app
33
A self-hosted app is hosted by one or more merchants individually. To authorise, the app uses the authorisation assertion grant.
44

55
In an authorisation assertion grant flow, you use a JSON web token (JWT) assertion to request an access token from the authorisation server. The JWT assertion is used as an API key. An API key is created by a merchant (Zettle merchant account owner). It's valid until the merchant revokes it.
6-
<!-- add assertion grant in glossary -->
76

8-
To authorise your app using assertion grant, you need to ask the merchant (Zettle merchant account owner) to create an API key at my.zettle.com. You can provide the merchant a deep link that directs them to the API creation page or steps to create an API key.
7+
To authorise your app using assertion grant, you need to ask the merchant (Zettle merchant account owner) to create an API key at my.zettle.com. You can provide the merchant a link that directs them to the API creation page or steps to create an API key.
98

109
> **Note:** If you want to build a partner-hosted app that will be hosted by you as an integrator, [create a partner-hosted app](../create-a-partner-hosted-app.md).
1110
@@ -22,7 +21,7 @@ To authorise your app using assertion grant, you need to ask the merchant (Zettl
2221
An API key must be created by the Zettle merchant that will use your app.
2322

2423
1. Ask the merchant to create an API key in one of the following ways:
25-
* Provide the merchant a deep link with pre-populated fields and [the instructions to create an API key with the deep link](create-an-api-key.md#create-an-api-key-with-a-deep-link-from-the-developer).
24+
* Provide the merchant a link with pre-populated fields and [the instructions to create an API key with the link](create-an-api-key.md#create-an-api-key-with-a-link-from-the-developer).
2625
```
2726
https://my.zettle.com/apps/api-keys?name=<key-name>&scopes=<scopes>
2827
```

oauth-api/user-guides/set-up-app-authorisation/set-up-authorisation-assertion-grant.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To build a self-hosted app with APIs, you need to set up the authorisation asser
1212
## Prerequisites
1313
* You have an account for the [Developer Portal](https://developer.zettle.com/). If you don't have an account, [sign up for a developer account](../../../get-started/user-guides/sign-up-for-a-developer-account.md).
1414

15-
* You have an API key and a client ID for the app. If you don't have any, [create a self-hosted app](../create-an-app/create-a-self-hosted-app).
15+
* You have an API key and a client ID for the app. If you don't have any, [create a self-hosted app](../create-an-app/create-a-self-hosted-app/create-a-self-hosted-app.md).
1616

1717
## Step 1: Retrieve an access token from an API key
1818
To retrieve a short-lived access token from the API key, include the API key and the client ID in the following request.
@@ -46,7 +46,7 @@ An access token is valid only for 7200 seconds. Use the same API key to generate
4646

4747

4848
## Previous task
49-
* [Create a self-hosted app](../create-an-app/create-a-self-hosted-app)
49+
* [Create a self-hosted app](../create-an-app/create-a-self-hosted-app/create-a-self-hosted-app.md)
5050

5151
## Related API reference
5252
* [OAuth2 API Reference](../../../authorization.md)

oauth-api/user-guides/set-up-app-authorisation/set-up-authorisation-code-grant.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ An access token is valid only for 7200 seconds. When it expires, use the refresh
8787
Request
8888

8989
```
90-
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=refresh_token&refresh_token=IZSEC90590831-93a5-4289-ee37-a17824c0fea1&client_secret=IZSECe8b27fdb-faea-46e1-a886-6eded9f84f72}&client_id=6adde977-c34d-4de1-99b2-f6ed3e65431a" https://oauth.zettle.com/token
90+
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=refresh_token&refresh_token=IZSEC90590831-93a5-4289-ee37-a17824c0fea1&client_secret=IZSECe8b27fdb-faea-46e1-a886-6eded9f84f72&client_id=6adde977-c34d-4de1-99b2-f6ed3e65431a" https://oauth.zettle.com/token
9191
```
9292
Response
9393
```json

0 commit comments

Comments
 (0)