Skip to content

Commit e47ec0e

Browse files
committed
no more v2 in api endpoint path
1 parent 43ee1f1 commit e47ec0e

File tree

7 files changed

+38
-8
lines changed

7 files changed

+38
-8
lines changed

docs/apis/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 4
33
---
44

55
# Authentication

docs/apis/basics.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ Make sure to set the `Content-Type` header to `application/json` at all times:
1111
```
1212
Content-Type: application/json
1313
```
14+
15+
:::info
16+
Only JSON format is supported; other formats are not supported.
17+
:::

docs/apis/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,11 @@ The following resources are available via DePay's APIs:
3838
<a className="pt-1 d-block" href="/docs/apis/links/payments">→ Payments</a>
3939
</div>
4040

41+
<br/>
42+
43+
<div><strong><a href="/docs/apis/shopify">Shopify</a></strong></div>
44+
<div className="ps-2">
45+
<a className="pt-1 d-block" href="/docs/apis/shopify">→ Payments</a>
46+
</div>
47+
4148

docs/apis/links/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 5
33
sidebar_label: Links
44
---
55

docs/apis/links/payments.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For efficient payment status synchronization, it's advised against using API end
1616
## GET
1717

1818
```
19-
GET https://api.depay.com/v2/links/:link_id/payments
19+
GET https://api.depay.com/links/:link_id/payments
2020
```
2121

2222
### Required Parameters
@@ -30,7 +30,7 @@ GET https://api.depay.com/v2/links/:link_id/payments
3030
### Example Request
3131

3232
```
33-
GET https://api.depay.com/v2/links/4cZQFsap1QbLIlnVC5hscB/payments
33+
GET https://api.depay.com/links/4cZQFsap1QbLIlnVC5hscB/payments
3434
```
3535

3636
### Example Response
@@ -57,5 +57,5 @@ GET https://api.depay.com/v2/links/4cZQFsap1QbLIlnVC5hscB/payments
5757
This endpoint has a limit of 10 payments that are responded per request. Use `after` of the last received payment per response to paginate through the result set:
5858

5959
```
60-
GET https://api.depay.com/v2/links/4cZQFsap1QbLIlnVC5hscB/payments?after=2023-04-21T15:52:34.937960Z
60+
GET https://api.depay.com/links/4cZQFsap1QbLIlnVC5hscB/payments?after=2023-04-21T15:52:34.937960Z
6161
```

docs/apis/shopify.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 6
33
sidebar_label: Shopify
44
---
55

@@ -16,15 +16,15 @@ Only succeded payments are returned via this endpoint.
1616
:::
1717

1818
```apib
19-
### GET https://api.depay.com/v2/payments/shopify/{id}
19+
### GET https://api.depay.com/payments/shopify/{id}
2020

2121
+ Attributes
2222

2323
+ id: 'r0jveQYVIoqGGcXM7JjAap1u4' (string, required) - The id of the shopify payment.
2424

2525
+ Request (application/json)
2626

27-
GET https://api.depay.com/v2/payments/shopify/r0jveQYVIoqGGcXM7JjAap1u4
27+
GET https://api.depay.com/payments/shopify/r0jveQYVIoqGGcXM7JjAap1u4
2828

2929
+ Headers
3030

docs/apis/versioning.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Versioning
6+
7+
## Version Header
8+
9+
API versions are specified using the `x-api-version` header.
10+
11+
Ensure that this header is set to the version of the API you are implementing at all times:
12+
13+
```
14+
x-api-version: v2
15+
```
16+
17+
## History and Changelog
18+
19+
`v2`: Latest version. No breaking changes.

0 commit comments

Comments
 (0)