Developer Portal

Introduction to the developer portal features.

Venly Developer Portal sign in/ signup

Venly Developer Portal sign in/ signup

The updated portal dashboard now includes information on your:

Requests

This section shows the number of API requests made on the production and sandbox environment, and the number of errors. Click on Details to view a detailed view of your API requests.

Compute Units

The number of compute units consumed and remaining compute units. Click on Mnaage to manage your subscription plan.

๐Ÿ“˜

Click here to read more about compute units.

Portal Dashboard

Portal Dashboard

Integrations

At a glance, you can view all of Venly's integrations and click on them to read the documentation or getting started guide.

Venly Integrations

Venly Integrations

The authentication page encompasses everything you need to authenticate with Venly services. There are two categories: the Widget and the API services. Both services use a different authentication method, which you can read about by clicking on either the Widget or API documentation.

Access Credentials

The access credentials for the widget and API services are provided. The widget is authenticated using the client ID and whitelisted URLs, while the API services are authenticated using the client ID and client secret. You can switch between production & sandbox credentials by clicking the toggle button on the top right.

๐Ÿ“˜

Click here to read more about how to authenticate with different Venly services.

Endpoints

Here you can view the endpoints for authentication and different API services. Switching between the sandbox and the production environment also changes these endpoints.

๐Ÿ“˜

Click here to read details about our Sandbox and Production environment and supported blockchains.

Authentication Page

Authentication Page

Login events

You can view the login events whenever your access credentials are used to authenticate with Venly. You get the date, time, and IP address used when the login occurred. Keep track of this section to make sure the login events occur only from your IP address. If you see an unknown login attempt from an unknown IP address, your access credentials could be compromised. See the next section about attack mode.

Attack Mode

By turning on this feature, you can immediately stop all incoming traffic from your clients or servers to our system. This is a helpful step to protect your platform if there is a hacking attempt or another security issue. Activate Attack Mode confidently, knowing your system is shielded from unauthorized access and potential vulnerabilities.

๐Ÿ“˜

You can also read our detailed API security guide which describes best practices for protecting your users from malicious attacks by clicking on Read more, or by clicking here.

Authentication Features

Authentication Features

Configuration

This section is used to configure settings for the widget and API services, for example creating webhooks, changing permissions, etc.

  • Create and configure webhooks
  • Enable or disable wallet exporting permission
  • Use the Matic and Avalanche faucet (for the sandbox environment)

  • Create and configure webhooks

  • Configure initialization URLs (the URLs from where the widget functions will be called)
  • Configure log-out URLs (the URL where your user will be redirected to when they log out)
  • Upload your company logo to be visible on the widget
  • Add a description to the widget about your company
Configure the Widget and API services

Configure the Widget and API services

The usage section has complete details on:

  • Total number of requests
  • Total number of compute units consumed
  • Total number of errors

Further, you can filter the results based on the following:

  • Time period
  • Component (Authentication, Wallet API, NFT API, etc)

๐Ÿ“˜

Click here to read how to track the usage of compute units.

Track usage and compute units

Track usage and compute units

The settings page lets you add or update your company name, VAT, billing email, and billing address. The following can be updated or added to the billing address:

  1. Country
  2. City
  3. Postal/ ZIP Code
  4. State/ Province
  5. Street Address
Update Billing Address

Update Billing Address

Invite new and existing users to join your company via email. Each invitation link will be valid for 10 days, during which users can choose to accept or decline the invitation. Once accepted, your company's users will share access credentials.

Additionally, we have made it simple to manage user access: you can delete a user from your company or resend invitations if the link has expired, the user declines the invitation, or the user has been deleted.

๐Ÿ“˜

Admin rights are the same amongst all users of your company.

Inviting Users to your Company

Inviting Users to your Company

  1. View all your invoices at a glance
  2. Pay invoices straight from the Portal
  3. Download invoices
  4. View and manage your subscription plan
  5. Add a credit card
  6. Update credit card details

๐Ÿšง

Scroll to the bottom of the billing page to cancel your plan.

Consequences of cancelling:

  • All of your users will lose access to the platform and any wallets associated with it.
  • All assets (NFTs, tokens, wallets, etc.) will remain on the blockchain.
  • You can re-enable your account at any time.
Manage Billing and Plans

Manage Billing and Plans