CryptoPhoto API Session

Before being able to deploy the CryptoPhoto service into your website, you must register a new CryptoPhoto administration account and obtain a set of API Keys.

Creating and configuring a CryptoPhoto administration account is described here.

Before an end user can use the CryptoPhoto service, you (3rd party) have to obtain a CryptoPhoto session ID from CryptoPhoto.com.

This is achieved by doing a POST request to http[s]://CryptoPhoto.com/api/get/session. Below are the relevant parameters.

API Request

URL: http[s]://CryptoPhoto.com/api/get/session

API Response

The response is a series of strings separated by \n. To read the string, split the line and read each field. (New lines may be added in the future)

Displaying CryptoPhoto Token Generation Widget

The first step in integrating CryptoPhoto is making the Token Generation Widget show up on one of your user's account page.

Your user can then use this page to create/download new CryptoPhoto Token or manage existent Tokens.

To make the Token Generation Widget appear when your page loads, you will need to insert this snippet of JavaScript code in your <form> element and replace session_id with the CryptoPhoto session ID obtained at the previous step:

 <script type="text/javascript"
   src="https://CryptoPhoto.com/api/token?sd=session_id">
 </script>

So your page will look something like this:

  <!-- ... your HTML content ... -->

  <form action="" method="post">

    <!-- ... your form code here ... -->

    <script type="text/javascript"
      src="https://CryptoPhoto.com/api/token?sd=session_id">
    </script>
    
    <!-- ... more of your form code here ... -->

  </form>

  <!-- ... more of your HTML content ... -->

Displaying CryptoPhoto Challenge Widget

The first step in integrating CryptoPhoto is making the CryptoPhoto Challenge Widget show up on a page after the user has been authenticated by the usual username/password techniques.

We recommend showing the CryptoPhoto Challenge Widget image after you've acquired your user's name and password, so that you know which uid to use when getting a new CryptoPhoto session ID.

To make the CryptoPhoto Challenge Widget appear when your page loads, you will need to insert this snippet of JavaScript code in your <form> element and replace session_id with the CryptoPhoto session ID obtained at the previous step:

 <script type="text/javascript"
   src="https://CryptoPhoto.com/api/challenge?sd=session_id">
 </script>

So your page will look something like this:

  <!-- ... your HTML content ... -->

  <form action="" method="post">

    <!-- ... your form code here ... -->

    <script type="text/javascript"
      src="https://CryptoPhoto.com/api/challenge?sd=session_id">
    </script>
    
    <!-- ... more of your form code here ... -->

  </form>

  <!-- ... more of your HTML content ... -->

There are four new form fields created:

• token_response_field_row is a text field where the user enters their row code. It corresponds to the "response_row" parameter required by the CryptoPhoto verification API.
• token_response_field_col is a text field where the user enters their column response. It corresponds to the "response_col" parameter required by the CryptoPhoto verification API.
• token_selector is a drop down containing all tokens associated with the user. It corresponds to the "selector" parameter required by the CryptoPhoto verification API.
• cp_phc is a text field that will be automatically filled when the user authenticates with a mobile device. It corresponds to the "cph" parameter required by the CryptoPhoto verification API.

These four fields will be passed to the script on your server that processes this form and verifies the CryptoPhoto response via the CryptoPhoto verification API.

Verifying the User's Answer

After your page is successfully displaying CryptoPhoto Challenge Widget, you need to configure your form to check whether the answers entered by the users are correct. This is achieved by doing a POST request to http[s]://CryptoPhoto.com/api/verify. Below are the relevant parameters.

API Request

URL: http[s]://CryptoPhoto.com/api/verify

API Response

The response from verify is a series of strings separated by \n. To read the string, split the line and read each field. (New lines may be added in the future)