GoParagon.Connector.Client 1.0.16

Connector .NET Client Library

Welcome to the Connector .NET Client Library! This library is designed to simplify the integration with various platforms such as QuickBooks Online, Microsoft Graph, G Suite, and more. By using the Connector app, you can access and manage data from these platforms through a unified API.

Overview

Connector is an app that facilitates seamless integration with multiple platforms. It allows you to:

• Connect to various platforms like QuickBooks Online, Microsoft Graph, G Suite, and others.
• Retrieve and manage data from these platforms through a single set of APIs.
• Simplify the process of obtaining and using data from multiple sources in your applications.

The Connector .NET Client Library is a NuGet package that provides developers with easy access to the Connector's APIs. With this library, you can quickly integrate the Connector's functionality into your .NET applications.

Features

• Unified API Access: Interact with multiple platforms using a single, consistent API.
• Easy Authentication: Simplify the process of authenticating and connecting to various services using API-KEY.
• Data Management: Retrieve, manipulate, and manage data from different platforms effortlessly.
• Extensibility: Easily extend and customize the integration to fit your specific needs.

Getting started

To get started using the Connector client, you will:

• Need to have API-KEY you can get it from Connector website
• Need to have at least one connect (QuickBook online, Microsoft, etc ...) to use their APIs

After you install the nuget package and get the API-KEY, you can use it.

using Connector.Client;
using Connector.Client.ApiService;

var connection = ConnectionBuilder.Create()
    .WithEndpoint("https://portalapi.para-apps.com")
    .WithApiKey("YOUR-API-KEY")
    .Build();

var customerService = new QuickBookCustomerService(connection);

var customers = await customerService.QueryAsync("select * from customer");

Paradigm ERP Integration

The Connector .NET Client Library now includes specific functionality for integrating with Paradigm ERP. With this feature, you can easily register users, generate access URLs, retrieve user information, and log users out from the Paradigm ERP platform.

User Registration and Access URL Generation

Step 1: User Registration with SignUpUserAsync

To register a user for the first time:

1. Create a connection using the ParadigmApiKey.
2. Create an instance of ParadigmErpService using the connection.
3. Use the SignUpUserAsync method to register the, specifying their email, provider, username, and company name. The method will return a URL directing the user to the Connector’s web interface.

var connectionForParadigm = ConnectionBuilder.Create()
    .WithEndpoint("https://portalapi.para-apps.com")
    .WithParadigmApiKey("PARADIGM_API_KEY")
    .Build();

var paradigmErpService = new ParadigmErpService(connectionForParadigm);

var response = await paradigmErpService.SignUpUserAsync(
    "test@gmail.com", 
    "Google", 
    "Your Username", 
    "Your Company Name"
);
Console.WriteLine(response.Url); // URL directing to the web interface

If you want to specify which connects to show on web interface, you can use the SignUpUserAsync method with the connects parameter:

var result = await paradigmErpService.SignUpUserAsync("test@gmail.com", "Google","Bob", "Your company name" });

Available connects are: Google, Microsoft, QuickBook, HubSpotParadigm.

The SignUpUserAsync method will return an object with:

• Url: Directs the user to the Connector’s web interface for further setup.
• ApiKey: The API key for the registered user, allowing API access.

Step 2: Access URL Generation with GeneratePortalAccessUrlAsync

If you need to generate an access URL again:

1. Create a new connection using the ApiKey received from the initial SignUpUserAsync response, or retrieve the key from the Connector web interface.
2. Create an instance of ParadigmErpService with the ApiKey-based connection.
3. Use GeneratePortalAccessUrlAsync to retrieve the access URL.

var connection = ConnectionBuilder.Create()
    .WithEndpoint("https://portalapi.para-apps.com")
    .WithApiKey(response.ApiKey) // Use the ApiKey from SignUpUserAsync response or web interface
    .Build();

var erpService = new ParadigmErpService(connection);

var response = await erpService.GeneratePortalAccessUrlAsync("test@gmail.com");
Console.WriteLine(response.Url); // Access URL for the web interface

The GeneratePortalAccessUrlAsync method will provide an Url that can be used to access the Connector platform again. This is useful for re-establishing access without needing to re-register the user.

Step 3: Retrieve User Information with GetUserInfoAsync

To get detailed user information:

1. Use the same connection created with the ParadigmApiKey.
2. Use the GetUserInfoAsync method, providing the API key and connect name.

var connection = ConnectionBuilder.Create()
    .WithEndpoint("https://portalapi.para-apps.com")
    .WithParadigmApiKey("PARADIGM_API_KEY")
    .Build();

var userInfoResponse = await new ParadigmErpService(connection)
    .GetUserInfoAsync(
        response.ApiKey, 
        "Microsoft"
    );

Console.WriteLine(userInfoResponse);

Step 4: Logout User with LogoutUserAsync

To log a user out from a specific provider:

1. Create a connection using the ParadigmApiKey.
2. Use the LogoutUserAsync method, providing the API key and the provider name.

var connection = ConnectionBuilder.Create()
    .WithEndpoint("https://portalapi.para-apps.com")
    .WithParadigmApiKey("PARADIGM_API_KEY")
    .Build();

await new ParadigmErpService(connection)
    .LogoutUserAsync(
        response.ApiKey, 
        "Microsoft"
    );

Console.WriteLine("User successfully logged out.");