Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luraph/luraph-dotnet
Luraph API binding for .NET
https://github.com/luraph/luraph-dotnet
Last synced: 29 days ago
JSON representation
Luraph API binding for .NET
- Host: GitHub
- URL: https://github.com/luraph/luraph-dotnet
- Owner: Luraph
- License: mit
- Created: 2024-02-02T15:37:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-23T08:30:18.000Z (10 months ago)
- Last Synced: 2024-12-14T08:26:13.702Z (about 2 months ago)
- Language: C#
- Size: 37.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# luraph-dotnet
[](https://www.nuget.org/packages/luraph.api)
[](https://www.nuget.org/packages/luraph.api)
[](https://github.com/Luraph/luraph-dotnet/actions/workflows/release.yml)
[](LICENSE)
This repository hosts the official SDK for interacting with the Luraph API from .NET environments.
**Luraph API access is only available for accounts under certain plans. For more information, please check out the pricing plans on the [Luraph website](https://lura.ph/#pricing).**
## Installation
*See more information on the [NuGet Gallery Page](https://www.nuget.org/packages/luraph.api).*
Installation via [.NET CLI](https://docs.microsoft.com/en-us/dotnet/core/tools/):
```sh
dotnet add package Luraph.API
```
Installation via [Package Manager Console](https://docs.microsoft.com/en-us/nuget/tools/package-manager-console):
```powershell
Install-Package Luraph.API
```
## Usage
*The official [Luraph API documentation](https://lura.ph/dashboard/documents/apidoc) contains the most up-to-date and complete information and instructions for integrating with the Luraph API.*
*Coming soon! See the [test file](LuraphTests/Program.cs) for an example integration.*
## Documentation
*The official [Luraph API documentation](https://lura.ph/dashboard/documents/apidoc) contains the most up-to-date and complete information and instructions for integrating with the Luraph API.*
### class LuraphAPI
#### new LuraphAPI(string apiKey)
Description: Creates an instance of the SDK.
Parameters:
- **apiKey** - API key to authenticate your requests. You can fetch your API key from your [account page](https://lura.ph/dashboard/account).
Returns: [*LuraphAPI*](#class-luraphapi)
---
#### GetNodes()
Description: Obtains a list of available obfuscation nodes.
Parameters: *None!*
Returns: [*NodesResponse*](#struct-nodesresponse)
---
#### CreateNewJob(string node, string script, string fileName, Dictionary<string, object> options, bool useTokens = false, bool enforceSettings = false)
Description: Queues a new obfuscation task.
Parameters:
- **node**: The node to assign the obfuscation job to.
- **script**: The script to be obfuscated.
- **fileName**: A file name to associate with this script. The maximum file name is 255 characters.
- **options**: An object containing keys that represent the option identifiers, and values that represent the desired settings. Unless `enforceSettings` is set to false, all options supported by the node must have a value specified, else the endpoint will error.
- **useTokens** - A boolean on whether you'd like to use tokens regardless of your active subscription.
- **enforceSettings** - A boolean on whether you'd like the `options` field to require *every* option requested by the server to be present with a valid value. If this is false, your integration will not break when invalid options are provided; however, updates that change Luraph's options will result in your integration using default settings when invalid values are specified. By default, this is set to `true`.
Returns: [*CreateJobResponse*](#struct-createjobresponse)
---
#### GetJobStatus(string jobId)
Description: This endpoint does not return until the referenced obfuscation job is complete. The maximum timeout is 60 seconds, and this endpoint can be called a **maximum** of 3 times per job.
Parameters:
- **jobId** - The job ID of the obfuscation to wait for.
Returns: [*ObfuscateStatusResponse*](#struct-obfuscatestatusresponse)
---
#### DownloadResult(string jobId)
Description: Downloads the resulting file associated with an obfuscation job.
Parameters:
- **jobId** - The job ID of the obfuscation to download.
Returns: [*ObfuscateDownloadResponse*](#struct-obfuscatedownloadresponse)
---
### struct LuraphOption
Fields:
- string **Name** - The human readable name associated with an option.
- string **Description** - The markdown formatted description for an option.
- [*LuraphOptionTier*](#enum-luraphoptiontier) **Tier** - Required tier to access the option.
- [*LuraphOptionType*](#enum-luraphoptiontype) **Type** - The type of input requested for the option.
- bool **Required** - If creating a user interface to integrate with Luraph, settings that contain a value of `true` for this field should be explicitly set by the user, since they have a high chance of causing incorrect output when not set properly.
- string[] **Choices** - An array of acceptable option values when `type == DROPDOWN`.
- Dictionary<string, object[]>? **dependencies** - An array of required prerequisite values before this setting can be changed from the default value.
---
### struct LuraphNode
Fields:
- double **CpuUsage** - The current CPU usage of the node.
- Dictionary<string, [*LuraphOption*](#struct-luraphoption)> **Options** - An object with option identifiers as keys and `LuraphOption` as values.
---
### struct LuraphError
Fields:
- string? **Param** - The parameter associated with the cause of the error.
- string **Message** - A human readable error message.
---
### struct NodesResponse
Fields:
- string? **RecommendedId** - The most suitable node to perform an obfuscation based on current service load and other possible factors.
- Dictionary<string, [*LuraphNode*](#struct-luraphnode)> **Nodes** - A list of all available nodes to submit obfuscation jobs to.
---
### struct CreateJobResponse
Fields:
- string **JobId** - A unique identifier for the queued obfuscation job.
---
### struct ObfuscateStatusResponse
Fields:
- bool **Success** - A boolean indicating whether the job was successful.
- string? **Error** - An error message if the job failed, or null if the job succeeded.
---
### struct ObfuscateDownloadResponse
Fields:
- string **FileName** - A sanitized version of the initial filename, including a suffix to differentiate it from the original filename.
- Stream **Data** - A stream containing the obfuscated script.
---
### class LuraphException : Exception
Fields:
- bool **IsHttpError** - Whether the exception was caused by an unhandled error.
- **Errors** - An array of [*LuraphError*](#struct-lurapherror).
- **Message** - A human readable collection of error messages returned by a request.
---
### enum LuraphOptionTier
Values:
- **CUSTOMER_ONLY** - All customers can access this option.
- **PREMIUM_ONLY** - Only customers on a plan with premium features can access this option.
- **ADMIN_ONLY** - Only administrators can access this option.
---
### enum LuraphOptionType
Values:
- **CHECKBOX** - Expects a boolean value.
- **DROPDOWN** - Expects a value contained in the option choices.
- **TEXT** - Expects any textual imput.
---
## Useful Links
- [Visit the Luraph Website](https://lura.ph/ "Luraph - Online Lua Obfuscation")
- [Join the Luraph Discord](https://discord.lura.ph/ "Luraph Discord Server")
- [Read the Luraph Documentation](https://lura.ph/dashboard/documents "Luraph Documentation")
- [Read the Luraph FAQs](https://lura.ph/dashboard/faq "Luraph Frequently Asked Questions")