Skip to content

Commit

Permalink
Add timeout section (#275)
Browse files Browse the repository at this point in the history
* Add timeout section

* fix typo
  • Loading branch information
angga1518 authored Jan 2, 2024
1 parent 87a88dc commit 26ab75c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
28 changes: 28 additions & 0 deletions source/includes/_timeout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Timeout

Timeouts can be set by partners when making requests to our API. This allows partners to control the maximum duration for which they are willing to wait for a response from our server.

## Timeout Durations for OY's API

Below is the list of timeout durations for OY's API:

API | Timeout in seconds
---------- | -------
E-Wallet Aggregator | 60

## Setting Timeout

Partners can set the timeout by including the `timeout` parameter in the request headers. The value of the `timeout` parameter should be specified in seconds.

## Example

```http
POST https://partner.oyindonesia.com/api/e-wallet-aggregator/create-transaction
Host: partner.oyindonesia.com
Content-Type: application/json
X-Oy-Username: yourusername
X-Api-Key: yourapikey
Timeout: 60
```

In this example, the partner is setting a timeout of 60 seconds for the request to POST /api/e-wallet-aggregator/create-transaction. Please note that OY's server will respond within this specified timeout duration.
1 change: 1 addition & 0 deletions source/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ includes:
- biller_api
- api_account_linking
- transaction_detail
- timeout
- docs_changelog

search: true
Expand Down

0 comments on commit 26ab75c

Please sign in to comment.