We are currently in the process of updating this sample template. If you are encountering any issues with the sample, please open an issue at github.com/twilio-labs/code-exchange/issues and we'll try to help you.
A simple Java, Spring and AngularJS implementation of a website that uses Twilio Authy to protect all assets within a folder with two-factor authentication. Additionally, it shows a Verify Phone Verification implementation.
It uses four channels for delivery, SMS, Voice, Soft Tokens, and Push Authentication. You should have the Authy App installed to try Soft Token and Push Authentication support.
Learn more about Account Security and when to use the Authy API vs the Verify API in the Account Security documentation.
Implementations in other languages:
.NET | Python | Node | PHP | Ruby |
---|---|---|---|---|
TBD | Done | Done | Done | Done |
- URL path "/protected" is protected with both user session and Twilio Authy Two-Factor Authentication
- One Time Passwords (SMS and Voice)
- SoftTokens
- Push Notifications (via polling)
- Phone Verification
- SMS or Voice Call
- Java Development Kit version 11 or later.
- A Twilio account - sign up
This application should give you a ready-made starting point for writing your own appointment reminder application. Before we begin, we need to collect all the config values we need to run the application:
Config Value | Description |
---|---|
Account Sid | Your primary Twilio account identifier - find this in the Console. |
Auth Token | Used to authenticate - just like the above, you'll find this here. |
Verification Sid | For Verification Service. You can generate one here |
Account Security Api Key | Create a new Authy application in the console. After you give it a name you can view the generated Account Security production API key. This is the string you will later need to set up in your environmental variables. |
You will need to create a new Authy application in the console. After you give it a name you can view the generated Account Security production API key. This is the string you will later need to set up in your environmental variables.
After the above requirements have been met:
-
Clone this repository and
cd
into itgit clone [email protected]:TwilioDevEd/account-security-quickstart-spring.git cd account-security-quickstart-spring
-
Set your environment variables
cp .env.example .env
See Twilio Account Settings to locate the necessary environment variables.
If you are using a UNIX operating system, load the environment variables before the application starts.
source .env
If you are using a different operating system, make sure that all the variables from the
.env
file are loaded into your environment. -
Run the application
make serve
NOTE: If you are using a dedicated Java IDE like Eclipse or IntelliJ, you can start the application within the IDE and it will start in development mode, which means any changes on a source file will be automatically reloaded.
-
Navigate to http://localhost:8080
That's it!
If you have Docker already installed on your machine, you can use our docker-compose.yml
to setup your project.
- Make sure you have the project cloned.
- Setup the environmental variables in the
docker-compose.yml
file, see the Twilio Account Settings. - Run
docker-compose --env-file /dev/null up
.
You can run the tests locally by typing:
./gradlew test
Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.
Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.
Service | |
---|---|
Heroku |
Some notes:
- For Heroku, please check this to properly configure the project for deployment.
- You can also follow this guide to deploy the application to several other cloud services including Google Cloud, Oracle Cloud, etc.
- The CodeExchange repository can be found here.
This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.
No warranty expressed or implied. Software is as is.