Choosing an SDK
Interact with our API in the language of your choice.
A Software Development Kit (SDK) is an open-source software package we maintain to make interacting with our API easier. Once installed and configured, an SDK provides objects and methods that abstract away low-level concerns like setting Authorization headers, encoding query string parameters, and parsing json responses.
All our SDKs have the following properties, unless otherwise noted:
- They are open source. Inspect code or contribute via our Github repositories.
- They are multi-platform. They work equally well on Windows, Linux, and OSX.
- They are semantically versioned. Version numbers indicate compatibility between versions.
- They are transparently changed. Notable changes are curated in a
CHANGELOG. - They are easily installed. Install from public repositories using your project’s package manager.
Choosing an SDK
We offer two types of SDKs: client-side and server-side.
| Client-side SDKs | Server-side SDKs | |
|---|---|---|
| Location | Browsers or mobile devices | Corporate networks or web servers |
| Installation | Package manager | |
| Function | Feature parity (although, slight differences may exist) | |
| Security | Can be inspected by end user | Cannot be inspected by end user |
| Secret keys | No, never! | Yes |
| Versioning | Semantic versioning | |
Security considerations
The biggest difference between client- and server-side SDKs is security. Because you cannot use secret keys in a client-side SDK, you will not be able to use riskier API features.
Client-side SDKs typically run on customers’ own devices. They can be compromised by users who unpack a mobile app to examine the SDK bytecode or use their browser’s developer tools to inspect internal site data. As a result, you should never use a secret API key in a client-side or mobile application.
Server-side SDKs, on the other hand, operate within server-architected applications running on your own infrastructure or trusted cloud-based infrastructure. Neither of these locations is directly accessible by end users. Because of the limited access to server-based applications, our secret API keys can safely retrieve snippets without needing to obscure or filter out sensitive data.
Language support
We offer SDKs in a growing number of languages and technologies. Explore the following SDK reference guides for specific details about how to use Jahuty with your tech stack.
| Language | Server-side? | Client-side? | Repository |
|---|---|---|---|
| Node.js | ✓ | ✗ | jahuty/jahuty-node |
| Ruby | ✓ | ✗ | jahuty/jahuty-ruby |
| PHP | ✓ | ✗ | jahuty/jahuty-php |
| Web | ✗ | ✓ | unpkg.com |
Find a typo? Something is wrong in this documentation? Fork and edit it!