FlexiAPI is a tool that is completing some features around the Flexisip server.
The application is connected to the Flexisip server and directly interact with it to offer a web interface providing those features.
Registration can be achieve using two methods if they are correctly configured and enabled by your administrator.
You can create an account using an email address . The form requires you to provide an username and your email address.
Once completed a confirmation email containing a unique link will be sent to the address. This link is used to activate your account, allowing you to finish the setup.
The feature is not enabled on this instance.
If enabled you can also create an account using a phone number . You can also add an optional nickname to personnalize your SIP address. If not, your phone number will be used as a username.
Once submitted, you will be asked to provide a unique pin code received by SMS to the phone number used during the registration.
Once activated FlexiAPI will ask your to provide a password to finish your account setup.
To authenticate please fill in the username or phone number and password you provided during the registration phase.
If you forgot your password or didn't configured it, you can always recover your account using the recover password forms, using your email address or phone number (not enabled) . Once authenticated you will then be able to change your password.
Once authenticated you will get access to your account panel .
You can change your email address from the panel. A confirmation email containing a unique link will be sent to validate the new one.
Your password can also be changed from the password change form . You can enable SHA-256 encrypted password when changing it (required for some clients).
Your account can be deleted from the panel using the account deletion form . You must re-enter your full SIP address to confirm the deletion.
From the devices management panel you will be able to list and delete the devices attached to your SIP address.
This panel is only accessible to admin accounts.
As an administrator, you will be able to generate an API Key allowing you to use the FlexiAPI API with the API Key authentication mechanism. Check the related API Documentation to know more about this feature.
From the accounts administration panel an administrator will be able to list, create, show, edit and and delete accounts from the attached Flexisip server.
Each user, identified by a unique number can be managed from the panel. The account can be activated or deactivated (see the Registration section for more information about activation).
You can also set an account as an administrator. The account will then have the same accesses and authorizations as you.
Finally the account page allows you to provision the account, using a QR Code or a unique link that can be shared with the contact.
The provisioning link can be generated and refreshed from this page as well. If the provisiong link is renewed, the old one will be unavailable.
Administrators can create and edit accounts directly from the admin panel. During the edition they can assign contacts (other accounts available in the local database), actions and types the same way it can be done in the API.
The deletion of an account is definitive, all the database related data (password, aliases…) will be destroyed after the deletion.
An adminisator can create, edit and delete account types. Those can be used to categorize accounts in clients, they are often used for Internet of Things related devices.
The statistics panel show registrations statistics based on their type (mobile and email based registration) and their activations states.