Skip to content

Commit 2accb72

Browse files
authored
Merge pull request #62 from SocketDotTech/feat/apikey
feat : added api key and versioning to apis
2 parents 16619fd + 75f4202 commit 2accb72

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

docs/dev-resources/APIReference/CheckConnection.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ The connection can be verified on-chain by calling the `getPlugConfig()` method
1313
## Off-chain
1414

1515

16-
**`GET`** [https://prod.dlapi.socket.tech/check-connection](https://prod.dlapi.socket.tech/check-connection)
16+
**`GET`** [https://prod.dlapi.socket.tech/v1/check-connection](https://prod.dlapi.socket.tech/check-connection)
17+
18+
**Header**: x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
1719

1820
| Query Param | Description |
1921
| --- | --- |
@@ -26,7 +28,9 @@ The connection can be verified on-chain by calling the `getPlugConfig()` method
2628

2729
Verifying a connection between Plugs deployed on Goerli and Mumbai testnet
2830

29-
[https://prod.dlapi.socket.tech/check-connection?slugA=2999&slugB=10&plugA=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&plugB=0x1812ff6bd726934f18159164e2927B34949B16a8](https://prod.dlapi.socket.tech/check-connection?slugA=2999&slugB=10&plugA=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&plugB=0x1812ff6bd726934f18159164e2927B34949B16a8)
31+
[https://prod.dlapi.socket.tech/v1/check-connection?slugA=2999&slugB=10&plugA=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&plugB=0x1812ff6bd726934f18159164e2927B34949B16a8](https://prod.dlapi.socket.tech/check-connection?slugA=2999&slugB=10&plugA=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&plugB=0x1812ff6bd726934f18159164e2927B34949B16a8)
32+
33+
Note : Add the *x-api-key* header mentioned above in the request for authentication.
3034

3135
#### Response Parameters
3236

docs/dev-resources/APIReference/EstimateFee.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ The fees for relaying messages can be calculated on-chain by calling the `getMin
5151
5252
## Off-chain API
5353
54-
**`GET`** [https://prod.dlapi.socket.tech/estimate-min-fees](https://prod.dlapi.socket.tech/estimate-min-fees)
54+
**`GET`** [https://prod.dlapi.socket.tech/v1/estimate-min-fees](https://prod.dlapi.socket.tech/estimate-min-fees)
55+
56+
**Header**: x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
57+
5558
5659
| Query Param | Description |
5760
| --- | --- |
@@ -64,7 +67,9 @@ The fees for relaying messages can be calculated on-chain by calling the `getMin
6467
6568
Estimating fees for sending a message from Polygon to Optimism
6669
67-
[https://prod.dlapi.socket.tech/estimate-min-fees?srcPlug=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&srcChainSlug=2999&dstChainSlug=10&msgGasLimit=100000](https://prod.dlapi.socket.tech/estimate-min-fees?srcPlug=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&srcChainSlug=2999&dstChainSlug=10&msgGasLimit=100000)
70+
[https://prod.dlapi.socket.tech/v1/estimate-min-fees?srcPlug=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&srcChainSlug=2999&dstChainSlug=10&msgGasLimit=100000](https://prod.dlapi.socket.tech/estimate-min-fees?srcPlug=0x7b9ed5C43E87DAFB03211651d4FA41fEa1Eb9b3D&srcChainSlug=2999&dstChainSlug=10&msgGasLimit=100000)
71+
72+
Note : Add the *x-api-key* header mentioned above in the request for authentication.
6873
6974
#### Response Parameters
7075

docs/dev-resources/APIReference/Track.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ sidebar_position: 3
66

77
Tracks the status of a message
88

9-
**`GET`** [https://prod.dlapi.socket.tech/messages-from-tx](https://prod.dlapi.socket.tech/messages-from-tx)
9+
**`GET`** [https://prod.dlapi.socket.tech/v1/messages-from-tx](https://prod.dlapi.socket.tech/messages-from-tx)
10+
11+
**Header**: x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
12+
1013

1114
#### Query Parameters
1215
| Query param | Description |
@@ -16,7 +19,9 @@ Tracks the status of a message
1619

1720
#### Example Request
1821

19-
[https://prod.dlapi.socket.tech/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc](https://prod.dlapi.socket.tech/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc)
22+
[https://prod.dlapi.socket.tech/v1/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc](https://prod.dlapi.socket.tech/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc)
23+
24+
Note : Add the *x-api-key* header mentioned above in the request for authentication.
2025

2126
#### Response Parameters
2227

0 commit comments

Comments
 (0)