Getting started

Welcome to Jahuty! We're excited to partner with you and help your team save tons of time. We know how difficult managing content in an application can be.

Here’s what you need to do to get started:

  1. Create your account.
  2. Open your first snippet.
  3. Install your first SDK.
  4. Render your first snippet.

Create your account

Sign up and create your Jahuty account. Remember to use a strong password. Your account is you, and your account is your password. Don’t worry about your data. We make money by providing a great service, not selling your data.

When you create your account, we’ll create an organization for you. An organization is a place where one or more people work together in Jahuty. Nearly everything in Jahuty is associated with an organization, including your account.

The organizations you belong to and the roles you are assigned within them determine what you can do in Jahuty. You can invite members to the organization we’ve created for you by sending invitations, or you can receive invitations from other organization owners.

Open your first snippet

When you created your account, we created a snippet for you. A snippet is a chunk of content your team would like to manage and share. It’s like a Google Doc or Word Document, except what you write will appear in your application.

Snippets are more than just text. You can use the Liquid templating language to add variables, filters, controls, and more. And, by using variables and parameters together, you can create templates that produce different output using the same snippet.

Install your first SDK

Installing a Software Development Kit (SDK) lets you output your snippet in your application. An SDK provides objects and methods that abstract away the details of our API. SDKs are available in a number of languages, and you can choose the one that fits your stack.

By default, our examples use curl and test sample data to interact with our API over HTTPS. Select one of our official SDKs to see examples in code.

$ npm install jahuty --save

$ composer require jahuty/jahuty-php

$ gem install jahuty

<script src="https://unpkg.com/@jahuty/jahuty"></script>

Render your first snippet

To render your first snippet, you’ll need two values:

  1. Your snippet’s id (the number beside your snippet’s name in the editor).
  2. Your organization’s API key (there’s a temporary one in your welcome email).

(In the examples below, we’ve used a sample test id and API key to provide a working example. To render your first snippet, you should replace the sample API key and snippet id with your actual values.)

curl https://api.jahuty.com/snippets/1/render \
  -H "Authorization: Bearer kn2Kj5ijmT2pH6ZKqAQyNexUqKeRM4VG6DDgWN1lIcc"; \
  echo
var { Jahuty, Snippet }  = require('@jahuty/jahuty');

Jahuty.setKey('YOUR_API_KEY');

Snippet.render(YOUR_SNIPPET_ID).then(render => console.log(render.content));
$jahuty = new \Jahuty\Client('kn2Kj5ijmT2pH6ZKqAQyNexUqKeRM4VG6DDgWN1lIcc');

echo $jahuty->snippets->render(1);
jahuty = Jahuty::Client.new(
  api_key: 'kn2Kj5ijmT2pH6ZKqAQyNexUqKeRM4VG6DDgWN1lIcc'
)

puts jahuty.snippets.render 1
<!doctype html>
<html>
  <head>
    <script src="https://unpkg.com/@jahuty/jahuty"></script>
    <script>
      window.addEventListener('load', function () {
        jahuty.Jahuty.setKey('kn2Kj5ijmT2pH6ZKqAQyNexUqKeRM4VG6DDgWN1lIcc');
        jahuty.Jahuty.initialize();
      });
    </script>
  </head>
  <body>
    <div data-snippet-id="1">
      <p>
        Hello, world!
      </p>
    </div>
  </body>
</html>

That’s it!

We hope you’ve enjoyed getting started with Jahuty! If you have any questions, let us know. Otherwise, feel free to learn more about Jahuty’s components, templates, SDKs, or API.

Find a typo? Something is wrong in this documentation? Fork and edit it!