Skip to content
This repository has been archived by the owner on Dec 16, 2020. It is now read-only.

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
angryziber committed Apr 10, 2012
1 parent a9e419d commit b2b9bd7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Expand Up @@ -12,17 +12,22 @@ Java and Mobile-ID
The official Mobile-ID API is a SOAP web service, so it usually takes time to generate the code and
start using it in a Java application.

This small library tries to solve this problem: just add the [*mobileid.jar* (with dependencies)](https://github.com/codeborne/mobileid/tree/master/build/libs)
This small library tries to solve this problem: just add the [*mobileid.jar* (with dependencies)](http://mvnrepository.com/artifact/com.codeborne)
to your project and you have a working Mobile-ID support. It already contains all the generated classes (by axis v1) as well as a simplified API of our own.

The same jar works in Scala as well or any other JVM-based language.

You can also use Maven/Ivy/Gradle/SBT or your favorite dependency manager that can fetch jars from the official Maven2 repo:

[com.codeborne :: mobileid](http://mvnrepository.com/artifact/com.codeborne/mobileid)

Usage
=====

Just use the public methods in [MobileIDAuthenticator](http://github.com/codeborne/mobileid/blob/master/src/com/codeborne/security/mobileid/MobileIDAuthenticator.java) class:

* startLogin(phoneNumber) - to initiate the login session, which will send a flash message to your mobile phone. The returned MobileIDSession contains the challenge code that you need to display to the user.
* waitForLogin(session) - to wait until user finally signs the challenge. This is a blocking call for simplicity.
* isLoginComplete(session) - if you want to do polling from the client side

See working example in [HelloMobileID.java](http://github.com/codeborne/mobileid/blob/master/test/com/codeborne/security/mobileid/HelloMobileID.java) - run the main() method.

0 comments on commit b2b9bd7

Please sign in to comment.