Skip to main content
Version: V2

Introduction

In order to interact with the CyberConnect API you're going to need a few things:

  1. API Key: Used to authenticate & identify your project (Required)
  • No expiration, only retrieve once - detailed in the next section
  1. Auth Token: Used to authenticate & identify your users (Required)
  • This has an expiration (1 day) and needs to be refreshed by refresh token (7 day) or re-login
  1. Relay Address: A unique address for each project to deposit fund so as to pay relay gas fee. (Optional)
  • Any transaction / smart contract interaction requires a user to have BNB to cover gas costs. This makes user onboarding and user experience painful. There is no way to have a high conversion rate when the users have to buy BNB before being able to use the application. To overcome this, we offer both a gas & gassless mode for developers:
    1. For gasless mode, developers can get your api key and relayer address on https://dashboard.cyberconnect.me/, this is covered (in the next step). You can use relayer to send meta-transactions for your users through your api key. As you can see in the diagram below, to enable gasless mode for your users, you must deposit funds (usually BNB, but other ERC20 tokens may be supported) into the relay address provided to cover gas. The relayer sending transaction for users is called relay . After relay , you will get the relayActionId which you should poll the relayActionId to check the transaction result.
    2. For gas mode, developers don’t need any api key or relayer’s help. You should call the smart contract directly and then call users’ wallet to send the transaction. Users have to pay for the gas.
tip

You can read more about relays & meta-transactions (here)

Mutations require Authorization header:

registerSigningKey
createCreateProfileTypedData
createRegisterEssenceTypedData
createCollectEssenceTypedData
createSetEssenceDataTypedData
createSubscribeTypedData
createSetSubscribeDataTypedData
createSetMetadataTypedData
Designed by