🌎 Dashboard APIs

Using these APIs one can create or delete a smart contract for a dapp. They can also create or delete a meta transaction api for a method of the contract without manually adding them on the dashboard.

Generate AUTH token

  1. Register & Login to https://dashboard.biconomy.io/​

  2. Go to the "Account" tab and select "Generate Token"

  3. Copy "token" and use it in APIs to add/delete smart contract & methods

post
/api/v1/smart-contract/public-api/addContract

https://api.biconomy.io/api/v1/smart-contract/public-api/addContract
API lets you add a new smart contract to an already registered dapp. Using the authToken generated from the Account section and the apiKey of a dapp, one can add a new smart contract for that dapp.
Request
Response
Request
Headers
authToken
required
string
Token unique to every user account
apiKey
required
string
Api Key unique to every dapp
Form Data Parameters
contractName
required
string
Name of the smart contract
contractAddress
required
string
Address of the smart contract
abi
required
string
Abi of the smart contract
contractType
required
string
"SC" or "SCW" if it is a Smart Contract or Smart Contract Wallet
walletType
optional
string
For contractType "SCW", walletType is "GNOSIS", otherwise leave blank.
metaTransactionType
optional
string
"DEFAULT", "TRUSTED_FORWARDER", "ERC20_FORWARDER" based on type of meta transaction
Response
200: OK
Smart contract successfully registered
{ "code" : 200, "message" : "SmartContract registered successfull", "responseCode" : 200 }
400: Bad Request
Happens when invalid contract address or abi is sent in request.
{ "code" : 400, "message" : "Enter valid abi (contract address)", responseCode : 400 }
401: Unauthorized
Failure of user authentication
{ "code" : 401, "message" : "Failure in authentication", "responseCode" 401 }
404: Not Found
Happens when User is not found
{ "code" : 144, "message" : "User Does Not Exist", responseCode: 143 }
406: Not Acceptable
When more than one Smart Contract Wallet is registered for a Dapp
{ "code" : 406, "message" : "Only one Smart Contract Wallet is allowed per Dapp", "responseCode" : 406 }
409: Conflict
Smart contract already exists
{ "code" : 409, "message" : "SmartContract already exists", "responseCode" : 409 }

delete
/api/v1/smart-contract/public-api/deleteContract

https://api.biconomy.io/api/v1/smart-contract/public-api/deleteContract
API lets you delete a smart contract. Using the authToken generated from the Account section and the apiKey of a dapp, one can delete a smart contract of that dapp.
Request
Response
Request
Headers
authToken
required
string
Token unique to every user
apiKey
required
string
Api Key unique to every dapp
Body Parameters
contractType
required
string
SC/SCW
contractAddress
required
string
Address of the smart contract
Response
200: OK
Smart contract successfully removed
{ "code" : 143, "message" : "Contract removed successfully", "responseCode": 143 }
401: Unauthorized
Failure of user authentication
{ "code" : 401, "message" : "Failure in authentication", "responseCode" 401 }
404: Not Found
{ "code" : 144, "message" : "User Does Not Exist", responseCode: 143 }

post
/api/v1/meta-api/public-api/addMethod

https://api.biconomy.io/api/v1/meta-api/public-api/addMethod
Using the authToken generated from the Account section and the apiKey of a dapp and API lets you add a contract method of an already registered smart-contract.
Request
Response
Request
Headers
authToken
required
string
Token unique to every user account
apiKey
required
string
Api Key unique to every dapp
Body Parameters
apiType
required
string
native/custom
methodType
required
string
"read"/"write" based on the method type
name
required
string
Placeholder name
contractAddress
required
string
contract address
method
required
string
Method name on smart contract
Response
200: OK
Meta api successfully registered
{ "code" : 143, "message" : "Api registered successfully", "responseCode" : 143 }
400: Bad Request
Email is not verified
{ "code" : 144, "message" : "Verify your email first", "responseCode" : 144 }
401: Unauthorized
Failure of user authentication
{ "code" : 401, "message" : "Failure in authentication", "responseCode" 401 }
409: Conflict
{ "code" : 144, "message" : "Api name already exists", responseCode : 144 }

delete
/api/v1/meta-api/public-api/deleteMethod

https://api.biconomy.io/api/v1/meta-api/public-api/addMethod
Using authToken and the apiKey of a dapp and the contract address of a smart contract, API lets you delete an already registered method from the dashboard.
Request
Response
Request
Headers
authToken
required
string
Token unique to every user account
apiKey
required
string
Api-Key unique to every dapp
Body Parameters
contractAddress
optional
string
Address of the smart contract
method
optional
string
Method name on the smart contract
Response
200: OK
Meta api successfully removed
{ "code": 143, "message" : "Api removed successfully", "responseCode" : 143 }
401: Unauthorized
Failure of user authentication
{ "code" : 401, "message" : "Failure in authentication", "responseCode" 401 }