Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caesarovich/intezer-js
A Node.JS integration of Intezer's API
https://github.com/caesarovich/intezer-js
api-client api-wrapper intezer malware-analysis nodejs-lts wrapper
Last synced: 29 days ago
JSON representation
A Node.JS integration of Intezer's API
- Host: GitHub
- URL: https://github.com/caesarovich/intezer-js
- Owner: Caesarovich
- License: gpl-3.0
- Created: 2021-05-17T21:07:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-19T23:16:37.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T06:43:10.236Z (2 months ago)
- Topics: api-client, api-wrapper, intezer, malware-analysis, nodejs-lts, wrapper
- Language: TypeScript
- Homepage:
- Size: 293 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  Intezer-js
### An **unofficial** Node.JS wrapper for [Intezer Analyze](https://analyze.intezer.com/)'s API.
### 📕 Complete documentation [➡️ here](https://caesarovich.github.io/intezer-js/)
### To-do / API Coverage:
This is a list of things that needs to be done before considering this library 'complete' (Objective v3.0)
Raw API wrapping:
- Community endpoints ✅
- Premium endpoints ❌
Client:
- Analysis wrapping: ✅
- SubAnalysis wrapping: ✅ / ❌
- Families: ❌
- Premium features: ❌
- Client Options: ✅
Other:
- Error wrapping/handling: ❌
- Usage flexibility (resolvables): ✅
- Make a user guide: ❌
Please feel free to contribute !
## 📥 Installation
### Option 1 - **Install from NPM**
```sh
npm install --save intezer-js
```
### Option 2 - **Clone and build from source**
```sh
# Clone the repo in your project directory
git clone https://github.com/Caesarovich/intezer-js
# Build the library
cd "intezer-js" && npm run build && cd ../
# Then install it to your project
npm install intezer-js
```
## ⏳ Quickstart
Follow these example to quickly start using the library.
> Note: You first need to [create an account](https://analyze.intezer.com/create-account) and get your [API Key](https://analyze.intezer.com/account-details).
## Retrieve an analysis using the **Client**
```js
import { Client } from 'intezer-js';
//...
// Instanciate a client with an API Key and initialise it.
const client = await new Client('API_KEY').init().catch(console.error);
// Retrieve an Analysis with an ID
const analysis = await client.analyses.get('ANALYSIS_ID').catch(console.error);
```
### Or with the **RawAPI**
> Note: _It is recommended to use the **Client** over the **RawAPI** because it provides much ease of use._
```js
import { RawAPI } from 'intezer-js';
//...
// Fetch an AccessToken using an API Key
const token = await RawAPI.getAccessToken('API_KEY').catch(console.error);
// Retrieve RawAnalysisData using the AccessToken and analysis ID.
const analysis = await RawAPI.getAnalysis(token, 'ANALYSIS_ID').catch(console.error);
```
## 📕 Documentation
#### READ THE FULL DOCUMENTATION **[HERE](https://caesarovich.github.io/intezer-js/)**
## 📔 Reference documentation
I used **[Intezer Analyze's API Documentation](https://analyze.intezer.com/api/docs/documentation)** as reference for this wrapper.
### 📄 Disclosure
This library is unofficial and not supported nor sustained by Intezer. Use it at your own risk !