Skip to content

dofusdude/dofusdude-csharp

BranchesTags

Repository files navigation

Dofusdude.Api - the C# library for the dofusdude

Open Ankama Developer Community

The all-in-one toolbelt for your next Ankama related project.

Versions

Client SDKs

  • Javascript npm i dofusdude-js - -save
  • Typescript npm i dofusdude-ts - -save
  • Go go get -u github.com/dofusdude/dodugo
  • Python pip install dofusdude
  • Java Maven with GitHub packages setup

Everything, including this site, is generated out of the Docs Repo. Consider it the Single Source of Truth. If there is a problem with the SDKs, create an issue there.

Your favorite language is missing? Please let me know!

Main Features

  • 🥷 Seamless Auto-Update load data in the background when a new Dofus version is released and serving it within 10 minutes with atomic data source switching. No downtime and no effects for the user, just always up-to-date.

  • ⚡ Blazingly Fast all data in-memory, aggressive caching over short time spans, HTTP/2 multiplexing, written in Go, optimized for low latency, hosted on bare metal in 🇩🇪.

  • 📨 Almanax Discord Integration Use the endpoints as a dev or the official Web Client as a user.

  • 🩸 Dofus 3 Beta from stable to bleeding edge by replacing /dofus3 with /dofus3beta.

  • 🗣️ Multilingual supporting en, fr, es, pt, de.

  • 🧠 Search by Relevance allowing typos in name and description, handled by language specific text analysis and indexing.

  • 🕵️ Official Sources generated from actual data from the game.

... and much more on the Roadmap on my Discord.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0-rc.8
  • SDK version: 1.0.0-rc.8
  • Generator version: 7.11.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://discord.gg/3EtHskZD8h

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Dofusdude.Api.Api;
using Dofusdude.Api.Client;
using Dofusdude.Api.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Dofusdude.Api.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Dofusdude.Api.Api;
using Dofusdude.Api.Client;
using Dofusdude.Api.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.dofusdu.de";
            var apiInstance = new AlmanaxApi(config);
            var language = fr;  // string | code
            var date = Tue Jul 14 00:00:00 UTC 2020;  // DateOnly | yyyy-mm-dd

            try
            {
                // Single Almanax Date
                Almanax result = apiInstance.GetAlmanaxDate(language, date);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AlmanaxApi.GetAlmanaxDate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.dofusdu.de

Class Method HTTP request Description
AlmanaxApi GetAlmanaxDate GET /dofus3/v1/{language}/almanax/{date} Single Almanax Date
AlmanaxApi GetAlmanaxRange GET /dofus3/v1/{language}/almanax Almanax Range
ConsumablesApi GetAllItemsConsumablesList GET /{game}/v1/{language}/items/consumables/all List All Consumables
ConsumablesApi GetItemsConsumablesList GET /{game}/v1/{language}/items/consumables List Consumables
ConsumablesApi GetItemsConsumablesSearch GET /{game}/v1/{language}/items/consumables/search Search Consumables
ConsumablesApi GetItemsConsumablesSingle GET /{game}/v1/{language}/items/consumables/{ankama_id} Single Consumables
CosmeticsApi GetAllCosmeticsList GET /{game}/v1/{language}/items/cosmetics/all List All Cosmetics
CosmeticsApi GetCosmeticsList GET /{game}/v1/{language}/items/cosmetics List Cosmetics
CosmeticsApi GetCosmeticsSearch GET /{game}/v1/{language}/items/cosmetics/search Search Cosmetics
CosmeticsApi GetCosmeticsSingle GET /{game}/v1/{language}/items/cosmetics/{ankama_id} Single Cosmetics
EquipmentApi GetAllItemsEquipmentList GET /{game}/v1/{language}/items/equipment/all List All Equipment
EquipmentApi GetItemsEquipmentList GET /{game}/v1/{language}/items/equipment List Equipment
EquipmentApi GetItemsEquipmentSearch GET /{game}/v1/{language}/items/equipment/search Search Equipment
EquipmentApi GetItemsEquipmentSingle GET /{game}/v1/{language}/items/equipment/{ankama_id} Single Equipment
GameApi GetGameSearch GET /{game}/v1/{language}/search Game Search
GameApi GetItemsAllSearch GET /{game}/v1/{language}/items/search Search All Items
MetaApi GetGameSearchTypes GET /{game}/v1/meta/search/types Available Game Search Types
MetaApi GetItemTypes GET /{game}/v1/meta/items/types Available Item Types
MetaApi GetMetaAlmanaxBonuses GET /dofus3/v1/meta/{language}/almanax/bonuses Available Almanax Bonuses
MetaApi GetMetaAlmanaxBonusesSearch GET /dofus3/v1/meta/{language}/almanax/bonuses/search Search Available Almanax Bonuses
MetaApi GetMetaElements GET /{game}/v1/meta/elements Effects and Condition Elements
MetaApi GetMetaVersion GET /{game}/v1/meta/version Game Version
MountsApi GetAllMountsList GET /{game}/v1/{language}/mounts/all List All Mounts
MountsApi GetMountsList GET /{game}/v1/{language}/mounts List Mounts
MountsApi GetMountsSearch GET /{game}/v1/{language}/mounts/search Search Mounts
MountsApi GetMountsSingle GET /{game}/v1/{language}/mounts/{ankama_id} Single Mounts
QuestItemsApi GetAllItemsQuestList GET /{game}/v1/{language}/items/quest/all List All Quest Items
QuestItemsApi GetItemQuestSingle GET /{game}/v1/{language}/items/quest/{ankama_id} Single Quest Items
QuestItemsApi GetItemsQuestList GET /{game}/v1/{language}/items/quest List Quest Items
QuestItemsApi GetItemsQuestSearch GET /{game}/v1/{language}/items/quest/search Search Quest Items
ResourcesApi GetAllItemsResourcesList GET /{game}/v1/{language}/items/resources/all List All Resources
ResourcesApi GetItemsResourceSearch GET /{game}/v1/{language}/items/resources/search Search Resources
ResourcesApi GetItemsResourcesList GET /{game}/v1/{language}/items/resources List Resources
ResourcesApi GetItemsResourcesSingle GET /{game}/v1/{language}/items/resources/{ankama_id} Single Resources
SetsApi GetAllSetsList GET /{game}/v1/{language}/sets/all List All Sets
SetsApi GetSetsList GET /{game}/v1/{language}/sets List Sets
SetsApi GetSetsSearch GET /{game}/v1/{language}/sets/search Search Sets
SetsApi GetSetsSingle GET /{game}/v1/{language}/sets/{ankama_id} Single Sets
WebhooksApi DeleteWebhooksAlmanaxId DELETE /webhooks/almanax/{id} Unregister Almanax Hook
WebhooksApi DeleteWebhooksRssId DELETE /webhooks/rss/{id} Unregister RSS Hook
WebhooksApi DeleteWebhooksTwitterId DELETE /webhooks/twitter/{id} Unregister Twitter Hook
WebhooksApi GetMetaWebhooksAlmanax GET /meta/webhooks/almanax Get Almanax Hook Metainfo
WebhooksApi GetMetaWebhooksRss GET /meta/webhooks/rss Get RSS Hook Metainfo
WebhooksApi GetMetaWebhooksTwitter GET /meta/webhooks/twitter Get Twitter Hook Metainfo
WebhooksApi GetWebhooksAlmanaxId GET /webhooks/almanax/{id} Get Almanax Hook
WebhooksApi GetWebhooksRssId GET /webhooks/rss/{id} Get RSS Hook
WebhooksApi GetWebhooksTwitterId GET /webhooks/twitter/{id} Get Twitter Hook
WebhooksApi PostWebhooksAlmanax POST /webhooks/almanax Register Almanax Hook
WebhooksApi PostWebhooksRss POST /webhooks/rss Register RSS Hook
WebhooksApi PostWebhooksTwitter POST /webhooks/twitter Register Twitter Hook
WebhooksApi PutWebhooksAlmanaxId PUT /webhooks/almanax/{id} Update Almanax Hook
WebhooksApi PutWebhooksRssId PUT /webhooks/rss/{id} Update RSS Hook
WebhooksApi PutWebhooksTwitterId PUT /webhooks/twitter/{id} Update Twitter Hook

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

About

The C# Client SDK for the Dofusdude API.

docs.dofusdu.de/

Topics

api client csharp dofus dofusdude

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

v0.9.0 Latest
May 7, 2024

Languages