Apideck 2.3.2

dotnet add package Apideck --version 2.3.2
NuGet\Install-Package Apideck -Version 2.3.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Apideck" Version="2.3.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Apideck --version 2.3.2
#r "nuget: Apideck, 2.3.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Apideck as a Cake Addin
#addin nuget:?package=Apideck&version=2.3.2

// Install Apideck as a Cake Tool
#tool nuget:?package=Apideck&version=2.3.2

Apideck .NET SDK

Build NuGet Apache-2 license

Table of Contents

Installation

Requirements

Use of the Apideck .NET SDK requires:

  • NET Standard 2.0 or higher

NuGet

Install using the dotnet CLI.

$ dotnet add package Apideck

Install with NuGet.exe.

$ nuget install Apideck
  • Use the Package Manager console for Visual Studio on Windows. In Visual Studio, right-click the project and choose Add NuGet Package. Search for the Apideck package and install it.

  • Use the Manage NuGet UI in Visual Studio on a Mac. In Visual Studio, right-click the project Dependencies and choose Manage NuGet Packages. Search for the Apideck package and install it.

  • In Visual Studio, right-click the project and choose Add NuGet Package. Search for the Apideck package and install it.

Getting started

The module supports all Apideck API endpoints. For complete information about the API, head to the docs.

Create new project

  1. Open your preferred integrated development environment (IDE), such as Visual Studio or Visual Studio Code.

  2. Create a new .NET project:

  • In Visual Studio: Go to "File" → "New" → "Project". Select the appropriate project template (e.g., Console App, Web App, etc.), provide a name for your project, and click "Create".
  • In Visual Studio Code: Open a terminal and navigate to the desired directory where you want to create your project. Use the following command: dotnet new console -n YourProjectName, replacing "YourProjectName" with the desired name for your project.
  1. Once the project is created, you need to add the required NuGet packages. You can do this using the NuGet Package Manager in Visual Studio or by running the following commands in the terminal (in the project directory):
dotnet add package Apideck

or install with Nuget

nuget install Apideck
  1. After adding the packages, you can replace the default code in the automatically generated Program.cs file with the desired code:

Example: Retrieving a list of all companies.

Example

using Apideck.Api;
using Apideck.Client;
using Apideck.Model;

namespace Example {
  public class CompaniesAllExample   {
    public static void Main()   {
      Configuration config = new Configuration();
      // Configure API key authorization: apiKey
      config.AddApiKey("Authorization", "API_KEY");
      config.AddApiKeyPrefix("Authorization", "Bearer");

      var apiInstance = new CrmApi(config);
      var raw = false;  // bool? | Include raw response. Mostly used for debugging purposes (optional)  (default to false)
      var consumerId = "CONSUMER_ID";  // string | ID of the consumer which you want to get or push data from (optional)
      var appId = "APP_ID";  // string | The ID of your Unify application (optional)
      var serviceId = "salesforce";  // string | Provide the service id you want to call (e.g., pipedrive). [See the full list in the connector section.](#section/Connectors) Only needed when a consumer has activated multiple integrations for a Unified API. (optional)

      try {
        Console.WriteLine("Calling Apideck");
        // List companies
        GetCompaniesResponse result = apiInstance.CompaniesAll(raw, consumerId, appId, serviceId);
        Console.WriteLine("Success", result);
      }
      catch (ApiException e) {
        Console.WriteLine("Exception when calling CrmApi.CompaniesAll: " + e.Message);
        Console.WriteLine("Status Code: " + e.ErrorCode);
        Console.WriteLine("Detail: " + e.ErrorContent);
      }
    }
  }
}
  • In Visual Studio: Open the Program.cs file in the Solution Explorer and replace its content with the code you provided.
  • In Visual Studio Code: Open the Program.cs file and replace its content with the code you provided.
  1. Make sure to replace "API_KEY", "CONSUMER_ID", "APP_ID", and "salesforce" with the actual values provided by Apideck. The API key represents your authentication credentials, while the other variables provide additional context for the API calls.

  2. Once you've updated the code, you can build and run your project. In Visual Studio, you can simply press F5 or click the "Start" button. In Visual Studio Code, use the following command in the terminal: dotnet run.

  3. The application will execute, and the output will be displayed in the console window. If successful, you should see the message "Calling Apideck" and, upon completion, a success message or an exception message if an error occurs.

<a name="documentation-for-api-endpoints"></a>

Apideck Unified Apis

The following Apis are currently available:

AccountingApi

Read the full documentation of the AccountingApi here.

AtsApi

Read the full documentation of the AtsApi here.

ConnectorApi

Read the full documentation of the ConnectorApi here.

CrmApi

Read the full documentation of the CrmApi here.

EcommerceApi

Read the full documentation of the EcommerceApi here.

FileStorageApi

Read the full documentation of the FileStorageApi here.

HrisApi

Read the full documentation of the HrisApi here.

IssueTrackingApi

Read the full documentation of the IssueTrackingApi here.

LeadApi

Read the full documentation of the LeadApi here.

PosApi

Read the full documentation of the PosApi here.

SmsApi

Read the full documentation of the SmsApi here.

VaultApi

Read the full documentation of the VaultApi here.

WebhookApi

Read the full documentation of the WebhookApi here.

Support

Open an issue!

License

Apache-2.0

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.3.2 84 5/16/2024
2.3.1 211 5/8/2024
2.3.0 156 4/18/2024
2.2.1 3,157 3/14/2024
2.2.0 2,184 2/23/2024
2.1.2 1,181 12/18/2023
2.1.1 151 12/11/2023
2.1.0 104 12/11/2023
2.0.1 3,038 11/2/2023
2.0.0 1,583 10/24/2023
1.8.3 114 10/23/2023
1.8.2 2,928 9/29/2023
1.8.1 103 9/25/2023
1.8.0 682 8/24/2023
1.7.2 185 8/7/2023
1.7.1 568 7/14/2023
1.7.0 154 5/31/2023
1.6.0 153 5/26/2023
1.5.0 313 4/24/2023
1.4.1 182 4/17/2023
1.4.0 1,245 12/22/2022
1.3.0 430 9/6/2022
1.2.0 400 8/18/2022
1.1.1 445 8/9/2022
1.1.0 452 7/8/2022
1.0.0 491 6/22/2022
0.1.4 451 6/16/2022
0.1.3 433 6/15/2022
0.1.2 433 6/15/2022
0.1.1 429 6/15/2022
0.1.0 438 6/14/2022

Automatic update based on our OpenAPI specifications: For more details, check out the changelog: https://docs.apideck.com/changelog