docs_sdk.html

<!-- Docs - SDK -->
<div class="section">
  <h2><a href="/docs/">Docs</a> : SDK</h2>

  <p>Userbase is accessible directly from the browser through a very simple <a href="/docs/installation/">JavaScript SDK</a>. The following is the complete set of APIs to create user accounts, handle logins, and persist user data.</p>

  <a class="anchor" id="sdk-initialize"></a>
  <h3>Initialize</h3>
  <p>Use this API to initialize your Userbase SDK and resume a session when a user returns to your web app.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/init/">init</a></li>
  </ul>

  <a class="anchor" id="sdk-users"></a>
  <h3>Users</h3>
  <p>Use these APIs to create/update/delete user accounts and handle logins.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/sign-up/">signUp</a></li>
    <li><a href="/docs/sdk/sign-in/">signIn</a></li>
    <li><a href="/docs/sdk/sign-out/">signOut</a></li>
    <li><a href="/docs/sdk/forgot-password/">forgotPassword</a></li>
    <li><a href="/docs/sdk/update-user/">updateUser</a></li>
    <li><a href="/docs/sdk/delete-user/">deleteUser</a></li>
  </ul>

  <a class="anchor" id="sdk-data"></a>
  <h3>Data</h3>
  <p>Use these APIs to store and retrieve user data. All data handled by these APIs is highly-durable, immediately consistent, and end-to-end encrypted.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/open-database/">openDatabase</a></li>
    <li><a href="/docs/sdk/get-databases/">getDatabases</a></li>
    <li><a href="/docs/sdk/insert-item/">insertItem</a></li>
    <li><a href="/docs/sdk/update-item/">updateItem</a></li>
    <li><a href="/docs/sdk/delete-item/">deleteItem</a></li>
    <li><a href="/docs/sdk/put-transaction/">putTransaction</a></li>
  </ul>

  <a class="anchor" id="sdk-files"></a>
  <h3>File Storage</h3>
  <p>Use these APIs to store and retrieve end-to-end encrypted files.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/upload-file/">uploadFile</a></li>
    <li><a href="/docs/sdk/get-file/">getFile</a></li>
  </ul>

  <a class="anchor" id="sdk-sharing"></a>
  <h3>Data Sharing</h3>
  <p>Use these APIs to share data between users securely.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/share-database/">shareDatabase</a></li>
    <li><a href="/docs/sdk/modify-database-permissions/">modifyDatabasePermissions</a></li>
    <li><a href="/docs/sdk/get-verification-message/">getVerificationMessage</a></li>
    <li><a href="/docs/sdk/verify-user/">verifyUser</a></li>
  </ul>

  <a class="anchor" id="sdk-payments"></a>
  <h3>Payments</h3>
  <p>Use these APIs to accept payments for your web app via Stripe. You can try it out for free, but to accept payments in production, you will need to purchase the Prod subscription.</p>
  <ul class="no-bullets tracking-normal">
    <li><a href="/docs/sdk/purchase-subscription/">purchaseSubscription</a></li>
    <li><a href="/docs/sdk/cancel-subscription/">cancelSubscription</a></li>
    <li><a href="/docs/sdk/resume-subscription/">resumeSubscription</a></li>
    <li><a href="/docs/sdk/update-payment-method/">updatePaymentMethod</a></li>
  </ul>
</div>

<hr>