Merge pull request #62 from SocketDotTech/feat/apikey

feat : added api key and versioning to apis
SocketDotTech · Apr 4, 2024 · 2accb72 · 2accb72
2 parents 16619fd + 75f4202
commit 2accb72
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/docs/dev-resources/APIReference/CheckConnection.md b/docs/dev-resources/APIReference/CheckConnection.md
@@ -13,7 +13,9 @@ The connection can be verified on-chain by calling the `getPlugConfig()` method
 ## Off-chain
 
 
-**`GET`** [https://prod.dlapi.socket.tech/check-connection](https://prod.dlapi.socket.tech/check-connection)
+**`GET`** [https://prod.dlapi.socket.tech/v1/check-connection](https://prod.dlapi.socket.tech/check-connection)
+
+**Header**:  x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
 
 | Query Param | Description |
 | --- | --- |
@@ -26,7 +28,9 @@ The connection can be verified on-chain by calling the `getPlugConfig()` method
 
 Verifying a connection between Plugs deployed on Goerli and Mumbai testnet
 
-[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)
+[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)
+
+Note : Add the *x-api-key* header mentioned above in the request for authentication. 
 
 #### Response Parameters
 

diff --git a/docs/dev-resources/APIReference/EstimateFee.md b/docs/dev-resources/APIReference/EstimateFee.md
@@ -51,7 +51,10 @@ The fees for relaying messages can be calculated on-chain by calling the `getMin
 
 ## Off-chain API
 
-**`GET`** [https://prod.dlapi.socket.tech/estimate-min-fees](https://prod.dlapi.socket.tech/estimate-min-fees)
+**`GET`** [https://prod.dlapi.socket.tech/v1/estimate-min-fees](https://prod.dlapi.socket.tech/estimate-min-fees)
+
+**Header**:  x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
+
 
 | Query Param | Description |
 | --- | --- |
@@ -64,7 +67,9 @@ The fees for relaying messages can be calculated on-chain by calling the `getMin
 
 Estimating fees for sending a message from Polygon to Optimism 
 
-[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)
+[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)
+
+Note : Add the *x-api-key* header mentioned above in the request for authentication. 
 
 #### Response Parameters
 

diff --git a/docs/dev-resources/APIReference/Track.md b/docs/dev-resources/APIReference/Track.md
@@ -6,7 +6,10 @@ sidebar_position: 3
 
 Tracks the status of a message 
 
-**`GET`** [https://prod.dlapi.socket.tech/messages-from-tx](https://prod.dlapi.socket.tech/messages-from-tx)
+**`GET`** [https://prod.dlapi.socket.tech/v1/messages-from-tx](https://prod.dlapi.socket.tech/messages-from-tx)
+
+**Header**:  x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
+
 
 #### Query Parameters
 | Query param | Description |
@@ -16,7 +19,9 @@ Tracks the status of a message
 
 #### Example Request
 
-[https://prod.dlapi.socket.tech/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc](https://prod.dlapi.socket.tech/messages-from-tx?srcChainSlug=10&srcTxHash=0xc3243233916c25f0455a9440fcd2183d49858149ad103c6ff8d6167d812bc0dc)
+[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)
+
+Note : Add the *x-api-key* header mentioned above in the request for authentication. 
 
 #### Response Parameters