.. meta::
  :description: Node.js API Documentation

.. _node_client:

Node.js API Client
------------------

.. raw:: html
   
    <div class="links-box">
        <a class="link-box lb-icon lb-icon-github" target="_blank" href="https://github.com/Recombee/node-api-client">
            <span>
            GitHub 
            <span class='desc'>Installation info and more examples</span>
            </span>
        </a>
        <a class="link-box lb-icon lb-icon-docs" target="_blank" href="_static/node/index.html">
            <span>
                Documentation 
                <span class='desc'>API Client</span>
            </span>
        </a>
    </div>


For client side (browser, mobile apps ...) .js library please see the :ref:`.js library <js_client>`.


.. rst-class:: lead

    Example

.. code-block:: js

    var recombee = require('recombee-api-client');
    var rqs = recombee.requests;

    var client = new recombee.ApiClient('--my-database-id--', '--my-private-token--');

    // Prepare some userIDs and itemIDs
    const NUM = 100;
    var userIds = Array.apply(0, Array(NUM)).map((_, i) => {
      return `user-${i}`;
    });

    var itemIds = Array.apply(0, Array(NUM)).map((_, i) => {
      return `item-${i}`;
    });


    // Generate some random purchases of items by users
    const PROBABILITY_PURCHASED = 0.1;
    var purchases = [];
    userIds.forEach((userId) => {
      var purchased = itemIds.filter(() => Math.random() < PROBABILITY_PURCHASED);
      purchased.forEach((itemId) => {

        purchases.push(new rqs.AddPurchase(userId, itemId, {'cascadeCreate': true}))

      });
    });

    // Send the data to Recombee, use Batch for faster processing of larger data
    client.send(new rqs.Batch(purchases))
      .then(() => {
        //Get 5 recommended items for user 'user-25'
        client.send(new rqs.RecommendItemsToUser('user-25', 5))
          .then((recommended) => {
            console.log("Recommended items for user-25: %j", recommended);
          });
      })
      .catch((error) => {
        console.error(error);
        // Use fallback
      });