get_started.html

{% extends "common-base.html" %}
{% load custom_tags %}
{% load humanize %}
{% load mixpanel %}

{% block extrahead %}
  {{ block.super }}
  
  <script type="text/javascript" src="{% static 'common/js/function01.js' %}"></script>

  <script>
    $(window).ready(function() {
      $('#signup').submit(function() {
        try {
          $.ajax(
            {
              type: "POST",
              data: { 'email': $('#email').val() },
              dataType: 'json',
              success: function(data, text, x) {
                //$('#email').val(data['api_key']);
                $('#get_api_url').hide();
                $('.user_email').text(data['email']);
                $('.logged_out').hide();
                $('.logged_in').show();
                $('.private_apiurl').text(data['private_api_url']);
                $('.public_apiurl').text(data['public_api_url']);
                $('#account_created').show();
                

                // if you wanted to use some tracking tool (mixpanel, google analytics? ),
                // this is the place to callback the service
              },
              error: function(x, text, err) {
                $('#email_error').text(x.responseText);
                $('.signup').val('SIGN UP');
              }
            }
          );
          $('#email_error').text('')
          $('.signup').val('...');
        } finally {
          return false;
        }
      });
    });  

  </script>

{% endblock %}


{% block title %}Get Started{% endblock %}

{% block tryit %}{% endblock %}


{% block right_content %}
  {% box 'blue_box01' %}
    <p>
      Free for first 100K docs.<br />
      $49/month for 500k docs.<br />
      $175/month for 2M docs.<br />
      Upgrade anytime.<br />
    </p>
    <div class="red_btn"> <a href="{% url pricing %}">CHOOSE PLAN</a> </div>
    {#<p class="size"><a href="mailto:support@indextank.com">Email us</a> if you have more than 500K docs for special pricing.</p>#}
  {% endbox %}
  {% box 'chat' %}
    <h2>HAVE A QUESTION?</h2>
    <div class="chat_btn"><a href="javascript:void(0)" onclick="go_chat()">LIVE CHAT NOW</a><span class="clear"></span></div>
    <p>Our team of experienced and friendly devs will respond almost as quickly as our search API.</p>
  {% endbox %}
{% endblock %}

{% block common_content %}
  {% if package.base_price %}
    {% include "includes/chosen_plan.html" %}
  {% else %}
    <h2 style="margin:0; padding:0">Try it Free in under 2 minutes</h2>
  {% endif %}
  <ul>
    <li>
      <h3 style="margin-top:0">1.&nbsp;Get your API urls</h3>
      {% if not request.user.is_authenticated %}
        <div id="get_api_url">
          <p>Enter your email address to get API Urls:</p>
          <form id="signup">
            <div class="form_sec">
              <div class="input_bg">
                <label><span class="none">&nbsp;</span>
                <input type="text" emptyvalue="Email" class="empty" name="" id="email" />
                </label>
              </div>
              <label>
              <input type="submit" value="SIGN UP" class="signup"/>
              <span class="none">&nbsp;</span> </label>
              <div id="email_error"></div>
            </div>
          </form>
        </div>
      {% endif %}
      <div id="account_created" {% if not request.user.is_authenticated %}style="display:none"{% endif %}>
        <p>Welcome <span class="user_email">{{ request.user.username }}</span>, your account has been successfully created. {#Please confirm your email address within the next 24hs, otherwise your account will be deleted.#}</p>
        {% if package.base_price > 0 %}
          {% if not user.is_authenticated or request.user.get_profile.account.status == "CREATING" %}
          <div class="messages warning" style="margin: 20px 35px 15px 40px; font-weight: normal;">
            Before you start using your account, you'll need to <br><a href="{% url enter_payment %}">enter your payment information</a>
          </div>
          {% endif %}
        {% endif %}
        <p>Here are the urls you need to access your API:</p>
        {% bg 'commands' %}
          <div class="commands_main apiurl">
            <h4>Private API url:&nbsp; {% with request.user.get_profile.account.get_private_apiurl as text %}{% include 'includes/clippy.html' %}{% endwith %}</h4>
            <a style="color:#3B8DB8; font-weight:bold; font-size:14px;" href="{{ request.user.get_profile.account.get_private_apiurl }}" class="private_apiurl">{{ request.user.get_profile.account.get_private_apiurl }}</a>
          </div>
        {% endbg %}
        {% bg 'commands' %}
          <div class="commands_main apiurl">
            <h4>Public API url:&nbsp; {% with request.user.get_profile.account.get_public_apiurl as text %}{% include 'includes/clippy.html' %}{% endwith %}</h4>
            <a style="color:#3B8DB8; font-weight:bold; font-size:14px;" href="{{ request.user.get_profile.account.get_public_apiurl }}" class="public_apiurl">{{ request.user.get_profile.account.get_public_apiurl }}</a>
          </div>
        {% endbg %}
      </div>
    </li>
    <li>
      <h3 style="margin-top:0">2.&nbsp;Install Library</h3>
      <div class="work_tab">
        <ul>
          <li><a href="javascript:void(0);" rel="content1" class="active"><span><img src="{% static 'common/images/work_icon03.gif' %}" alt="ruby" /></span></a></li>
          <li><a href="javascript:void(0);" rel="content2"><span><img src="{% static 'common/images/work_icon02.gif' %}" alt="python" /></span></a></li>
          <li><a href="javascript:void(0);" rel="content3"><span><img src="{% static 'common/images/work_icon04.gif' %}" alt="php" /></span></a></li>
          <li><a href="javascript:void(0);" rel="content4"><span><img src="{% static 'common/images/work_icon01.gif' %}" alt="java" /></span></a></li>
          <li><a href="javascript:void(0);" rel="content5"><span><img src="{% static 'common/images/work_icon05.png' %}" alt="other" /></span></a></li>
        </ul>
        <span class="clear"></span> 
      </div>
      {% bg 'work' %}
        <div class="work_main content1" style="display:block;">
          <p>For Ruby environments we provide a gem that handles all the REST calls for you in a very Ruby-fashioned way.</p>
          <p>&nbsp;</p>
          <p><b>Install our client:</b> <span style="font-family: 'Courier new'; font-size: 12px;">gem install indextank</span> {% with "gem install indextank" as text %}{% with "1" as small %}{% with "#999999" as bgcolor %}{% include 'includes/clippy.html' %}{% endwith %}{% endwith %}{% endwith %}
          </p>
          <p><b>Look at the client's <a href="http://github.com/flaptor/indextank-rb">source code</a></b></p>
          <p><b>Read the client <a href="{% url documentation path='ruby-client' %}">documentation</a></b></p>
        </div>
        <div class="work_main content2" style="display:none;">
          <p>For Python environments we provide a package that handles all the REST calls for you. You can install it with Pip or download the library:</p>
          <p>&nbsp;</p>
          <p><b>Install our client:</b> <span style="font-family: 'Courier new'; font-size: 12px;">pip install indextank</span> {% with "pip install indextank" as text %}{% with "1" as small %}{% with "#999999" as bgcolor %}{% include 'includes/clippy.html' %}{% endwith %}{% endwith %}{% endwith %}
          <p><b> Or Download Stable version:
            <a href="http://github.com/flaptor/indextank-py/zipball/stable">ZIP file</a> | 
            <a href="http://github.com/flaptor/indextank-py/tarball/stable">TGZ file</a>
          </b></p>
          <p><b>Look at the client's <a href="http://github.com/flaptor/indextank-php">source code</a></b></p>
          <p><b>Read the client <a href="{% url documentation path='python-client' %}">documentation</a></b></p>
        </div>
        <div class="work_main content3" style="display:none;">
          <p>For Php environments we provide a client that handles all the REST calls for you. Download a file that comes with the library ready to use.</p>
          <p>&nbsp;</p>
          <p><b>Download Stable version:
            <a href="http://github.com/flaptor/indextank-php/zipball/stable">ZIP file</a> | 
            <a href="http://github.com/flaptor/indextank-php/tarball/stable">TGZ file</a>
          </b></p>
          <p><b>Look at the client's <a href="http://github.com/flaptor/indextank-php">source code</a></b></p>
          <p><b>Read the client <a href="{% url documentation path='php-client' %}">documentation</a></b></p>
        </div>
        <div class="work_main content4" style="display:none;">
          <p>For Java environments we provide a basic API client that handles all the REST calls for you and translates the responses to simple Java objects.</p>
          <p>&nbsp;</p>
          <p><b>Download Stable version:
            <a href="http://github.com/flaptor/indextank-java/zipball/stable">ZIP file</a> | 
            <a href="http://github.com/flaptor/indextank-java/tarball/stable">TGZ file</a>
          </b></p>
          <p><b>Or add our maven client to your dependencies:</b></p>
    <pre style="font-family: 'Courier new'; font-size: 12px;">
    &lt;groupId&gt;com.indextank&lt;/groupId&gt;
    &lt;artifactId&gt;indextank-java&lt;/artifactId&gt;
    &lt;version&gt;1.0.6&lt;/version&gt;</pre>
          <p><b>Look at the client's <a href="http://github.com/flaptor/indextank-java">source code</a></b></p>
          <p><b>Read the client <a href="{% url documentation path='java-client' %}">documentation</a></b></p>
        </div>
        <div class="work_main content5" style="display:none;">
          <p>There might be an open source tool better suited to your needs. Check out the list maintained <a href="http://blog.indextank.com/737/the-state-of-the-indextank-ecosystem/">on our blog</a>.</p>
          <p>&nbsp;</p>
        </div>
      {% endbg %}
    </li>
    <li>
      <h3 style="margin-top:0">3.&nbsp;Test your account</h3>
      <p>First step is to instantiate the client</p>
      
      <div class="content1">
{% box 'commands' %}
<pre class="sh_ruby">
require 'rubygems'
require 'indextank'

api_url = "<span class="private_apiurl">{% if request.user.is_authenticated %}{{ request.user.get_profile.account.get_private_apiurl }}{% else %}&lt;YOUR API URL HERE&gt;{% endif %}</span>"
api = IndexTank::Client.new api_url
</pre>
{% endbox %}
      </div>
      
      <div class="content2" style="display:none">
{% box 'commands' %}
<pre class="sh_python">
from indextank.client import ApiClient
import time

api = ApiClient('<span class="private_apiurl">{% if request.user.is_authenticated %}{{ request.user.get_profile.account.get_private_apiurl }}{% else %}&lt;YOUR API URL HERE&gt;{% endif %}</span>')
</pre>
{% endbox %}
      </div>
      
      <div class="content3" style="display:none">
{% box 'commands' %}
<pre class="sh_php">
include_once "indextank_client.php";

$API_URL = '<span class="private_apiurl">{% if request.user.is_authenticated %}{{ request.user.get_profile.account.get_private_apiurl }}{% else %}&lt;YOUR API URL HERE&gt;{% endif %}</span>';
$client = new ApiClient($API_URL);
</pre>
{% endbox %}
        </p>
      </div>
      
      <div class="content4" style="display:none">
{% box 'commands' %}
<pre class="sh_java">
import com.flaptor.indextank.apiclient.IndexTankClient;
import com.flaptor.indextank.apiclient.IndexTankClient.Index;
import com.flaptor.indextank.apiclient.IndexTankClient.Query;

public class IndexTankTest {
  private final static String API_URL = 
    "<span class="private_apiurl">{% if request.user.is_authenticated %}{{ request.user.get_profile.account.get_private_apiurl }}{% else %}&lt;YOUR API URL HERE&gt;{% endif %}</span>";
  public static void main(String[] args) {
    IndexTankClient client = new IndexTankClient(API_URL);
  }
}
</pre>
{% endbox %}
      </div>
      
      <div class="clear"></div>
      <p class="pad04">Next, you need to get an index to start playing, you can create directly with the client.</p>
      
      <div class="content1">
{% box 'commands' %}
<pre class="sh_ruby">
index = api.indexes "MyFirstIndex"
index.add

while not index.running?
    sleep 0.5
end
</pre>
{% endbox %}
      </div>
      
      <div class="content2" style="display:none">
{% box 'commands' %}
<pre class="sh_python">
index = api.create_index('MyFirstIndex')

while not index.has_started():
    time.sleep(0.5)
</pre>
{% endbox %}
      </div>
      
      <div class="content3" style="display:none">
{% box 'commands' %}
<pre class="sh_php">
$index = $client-&gt;create_index("MyFirstIndex");

while (!$index-&gt;has_started()) {
  sleep(1);
}
</pre>
{% endbox %}
        </p>
      </div>
      
      <div class="content4" style="display:none">
{% box 'commands' %}
<pre class="sh_java">
Index index = client.createIndex("test_name");

while (!index.hasStarted()) {
  Thread.sleep(300);
}
</pre>
{% endbox %}
      </div>
      
      <div class="clear"></div>
      <p class="pad04">Now that you have created an index, and it has started, you can index documents and do queries.</p>
      
      <div class="content1">
{% box 'commands' %}
<pre class="sh_ruby">
docid = "MyDoc"
text = "some sample text"
index.document(docid).add({ :text => text })

results = index.search "some text"

print results['matches'], " results\n"
results['results'].each {|doc|
    docid = doc['docid']
    print "docid: #{docid}" 
}
</pre>
{% endbox %}
      </div>
      
      <div class="content2" style="display:none">
{% box 'commands' %}
<pre class="sh_python">
id = 'MyDoc'
text = 'some sample text'
index.add_document(id, { 'text': text })

results = index.search('some text')

print '%d results' % results['matches']
for doc in results['results']:
    print 'docid: %s' % doc['docid'] 
</pre>
{% endbox %}
      </div>
      
      <div class="content3" style="display:none">
{% box 'commands' %}
<pre class="sh_php">
$doc_id = 'MyDoc';
$text = 'some sample text';
$index-&gt;add_document($doc_id, array('text'=&gt;$text));

$res = $index-&gt;search('some text');

echo $res-&gt;matches . " results\n";
foreach($res-&gt;results as $doc) {
  print_r($doc);
  echo "\n";
}
</pre>
{% endbox %}
        </p>
      </div>
      
      <div class="content4" style="display:none">
{% box 'commands' %}
<pre class="sh_java">
String documentId = "MyDoc";
Map&lt;String, String> fields = new HashMap&lt;String, String&gt;();
fields.put("text", "some sample text");
index.addDocument(documentId, fields);

SearchResults results = index.search(Query.forString("some text"));

System.out.println("Matches: " + results.matches);

for (Map&lt;String, Object&gt; document : results.results) {
    System.out.println("doc id: " + document.get("docid"));
}
</pre>
{% endbox %}
      </div>
      
      <div class="clear"></div>
      
      <div class="content1">
        <p class="pad04">You have successfully created an index and performed queries. See what else
        you can do with the <a href="{% url documentation path='ruby-client' %}">Ruby client</a>, or
        try <a href="{% url demoindex %}">searching</a> over your own test index.
      </div>
      
      <div class="content2" style="display:none">
        <p class="pad04">You have successfully created an index and performed queries. See what else
        you can do with the <a href="{% url documentation path='python-client' %}">Python client</a>, or
        try <a href="{% url demoindex %}">searching</a> over your own test index.
      </div>
      
      <div class="content3" style="display:none">
        <p class="pad04">You have successfully created an index and performed queries. See what else
        you can do with the <a href="{% url documentation path='php-client' %}">PHP client</a>, or
        try <a href="{% url demoindex %}">searching</a> over your own test index.
      </div>
      
      <div class="content4" style="display:none">
        <p class="pad04">You have successfully created an index and performed queries. See what else
        you can do with the <a href="{% url documentation path='java-client' %}">Java client</a>, or
        try <a href="{% url demoindex %}">searching</a> over your own test index.
      </div>
      
      <p class="pad04">Don't forget to checkout your account's <a href="{% url dashboard %}">dashboard</a></p>
      
      
    </li>
  </ul>
{% endblock %}