Dashboard¶
The backend to the ETOPay SDK is accessible through our dashboard where you can:
- Login using GitHub.
- Manage your active projects.
- Retrieve the configuration needed to use the ETOPay SDK.
- Configure secrets required for integrating with KYC providers.
Login using GitHub¶
Open the dashboard and press the button to login through your GitHub account. By logging in and using our platform you agree to the Terms of Service and Privacy Policy. When authorizing the GitHub application, you also agree to that we can access the following information about your account:
- Your primary email address (even if it is marked as private). We use this information to communicate important updates and required actions about your projects.
Manage Projects¶
Creating a Project¶
After logging in for the first time, you'll be greated with a page that allows you to create a new project by signing up for your preferred plan.
Info
The payment is entirely handled through Stripe. We do not store or have access to your payment details at any time. After paying and creating a project you can manage your subscription at any time through the Manage Subscription navigation link.
When signing up for a new plan, a new project is created add added to your list of projects. You can create a new project, with your preferred plan, using the Create New Project button.
Each project includes two instances of the ETOPay services:
- A
test
instance used for testing during integration and development. - A
live
instance used for the actual production usage.
After creating a project, follow the Setup Guide shown on the Project Details page to perform the required one-time setup of the Keycloak administrator account that you will use to manage your end-users.
Managing a Project¶
Selecting a project brings you to the Project Details page. Using the toggle in the lower left corner you can select between the test
and the live
instance.
For each instance, you can see statistics about the number of Montly Active Wallets (MAWs) and the number of purchases that have been performed on your instance.
Using the navigation on the left side you can also visit the following pages:
- Project Details: The main page with statistics and information about your project, including the Setup Guide.
- User Management: Once your instance is created, you can use this link to manage your users in Keycloak.
- Purchases: Coming soon: Here you can inspect the purchases that were performed through your instance.
- Manage Subscription: This link will take you to Stripe to manage your subscription details.
- Project Settings: Here you can manage settings about your project instance. This has three tabs:
- General: General settings like project name and description. This is also where you can archive your project.
- Wallet: Here you see the list of pre-configured networks we support. In the future you will be able to add your own here.
- Secrets: This is where you configure secrets for integrating with KYC providers.
Retrieving Configuration¶
To retrieve the configuration needed for the SDK, go to the Project Details page of your project. Under Setup Guide you will find a template configuration JSON that you can use to initialize the SDK. See also Configuration for details on configuring the SDK.
Configuring Secrets¶
To use any of the supported KYC providers for enabling Know Your Customer (KYC) on your instance, visit the Secrets tab under Project Settings.
On this page, you can enter your access credentials for the respective provider. Note that you need to do this for the live
and test
instance separately.
If you need to rotate the credentials you can update them at any time, but you need to provide all values every time you save.
Info
The secret values you enter are write-only. Thus there is no way to retrieve the secret values once they are saved. Hence the text inputs will stay empty when the page is refreshed even when values are stored.