https://github.com/apyhub/apyhub.js
ApyHub SDK for Node.js is a library for accessing the ApyHub APIs.
https://github.com/apyhub/apyhub.js
api document-generation file-conversion image-generation image-processing nodejs text-extraction
Last synced: 4 months ago
JSON representation
ApyHub SDK for Node.js is a library for accessing the ApyHub APIs.
- Host: GitHub
- URL: https://github.com/apyhub/apyhub.js
- Owner: apyhub
- License: mit
- Created: 2022-12-22T06:36:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T04:48:03.000Z (almost 3 years ago)
- Last Synced: 2025-10-04T23:49:06.750Z (8 months ago)
- Topics: api, document-generation, file-conversion, image-generation, image-processing, nodejs, text-extraction
- Language: TypeScript
- Homepage: https://apyhub.com
- Size: 695 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ApyHub for Node.js
## About
Welcome to the ApyHub SDK for Node.js! This library provides easy access to the ApyHub APIs through a set of simple and powerful functions.
Our underlying philosophy is to not bloat applications, which is why we have made sure to keep the package as minimal as possible. With this SDK, you can easily perform tasks such as file conversion, text and metadata extraction, document and image generation, image processing, and access to data lists and currency conversion. As our platform grows and develops new APIs, we will be adding more functions to this library.
To learn more about ApyHub, visit our website at **[apyhub.com](https://www.apyhub.com/)** or join our Discord server at [**discord.com/invite/apyhub**](https://discord.gg/JZagJJcw6F).
## **API Documentation**
Our SDK provides access to the following API categories:
- [Convert API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/convert.md)
- [Data API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/data.md)
- [Extract API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/extract.md)
- [Generate API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/generate.md)
- [Image Processing API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/imageProcessor.md)
- [Validate API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/validate.md)
- [Search API](https://github.com/apyhub/apyhub.js/tree/main/docs/modules/search.md)
Each of these categories contains multiple functions for interacting with the corresponding API. For more examples and detailed API documentation, see the links above.
## **Installation**
To use this library, you will need to have Node.js and npm installed on your machine. Then, you can install the ApyHub SDK by running the following command:
```bash
npm install apyhub
```
## **Usage**
To use the library, you will need to initialize it with your ApyHub API token or Basic Authorization.
#### Token
```jsx
import { initApyhub } from "apyhub";
initApyhub("YOUR_APY_TOKEN");
```
#### Basic Authorization
```jsx
import { initApyhub } from "apyhub";
initApyhub({
username: "YOUR_AUTH_USERNAME",
password: "YOUR_AUTH_PASSWORD",
});
```
#### Optional parameters
The initApyhub function can also accept an optional options object with the following parameters:
- rateLimit: The rate limit for the API client (valid options are integers from 1 to 5, with a default value of 1).
- debug: A boolean flag to enable debugging output (default: false).
```jsx
import { initApyhub } from "apyhub";
initApyhub("YOUR_APY_TOKEN", {
rateLimit: 1,
debug: true,
});
```
## **Example**
Once the library is initialized, you can import and use the various functions and methods provided by the library. For example, to access the data list of countries, you can do the following:
```jsx
import { data } from "apyhub";
const countries = await data.countries();
```
For more examples, see the **[API documentation](https://github.com/apyhub/apyhub.js/tree/main/src#README.md)**.
## **Contributing**
We welcome contributions to this project. If you have an idea for a new feature or improvement, please open an issue to discuss it. If you'd like to contribute code, please follow these steps:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your branch to your fork on GitHub.
5. Open a pull request from your branch to the **`main`** branch of this repository.