عميل C# لواجهة برمجة تطبيقات StromGedacht
متاح على نوجيت.
dotnet add package StromGedacht.NET
أو
PM > Install-Package StromGedacht.NET
يمكن للعميل تقديم حالة المنطقة في الوقت الحالي أو جميع الولايات لفترة زمنية معينة.
قد تمتد الفترة بحد أقصى يومين في المستقبل و4 أيام في الماضي.
في كل مرة تقوم فيها بتقديم طلب، سوف تحتاج إلى تقديم الرمز البريدي للمنطقة التي تريد طلب الولاية الخاصة بها.
قم أولاً بإنشاء مثيل StromGedachtClient
عن طريق تمرير مثيل HttpClient
إلى المُنشئ الخاص به.
var httpClient = new HttpClient ( ) ;
var client = new StromGedachtClient ( httpClient ) ;
يمكنك جلب الحالة الحالية للمنطقة عن طريق استدعاء أساليب Now
/ NowAsync
وتمرير الرمز البريدي للمنطقة.
var state = client . Now ( "70173" ) ;
var state = await client . NowAsync ( "70173" ) ;
إذا أرجعت واجهة برمجة التطبيقات خطأً، فستُرجع هذه الطريقة null
. يمكن أن يحدث هذا إذا كان الرمز البريدي غير صالح / غير مدعوم.
يمكنك جلب جميع حالات المنطقة لفترة زمنية محددة عن طريق استدعاء أساليب States
/ StatesAsync
وتمرير الرمز البريدي للمنطقة ووقت البدء ووقت الانتهاء.
يمكن أن يكون وقت البدء والانتهاء تاريخين:
var from = new DateTimeOffset ( 2023 , 1 , 1 , 0 , 0 , 0 , TimeSpan . FromHours ( 2 ) ) ;
var to = new DateTimeOffset ( 2023 , 1 , 3 , 23 , 59 , 59 , TimeSpan . FromHours ( 2 ) ) ;
var states = client . States ( "70173" , from , to ) ;
var from = new DateTimeOffset ( 2023 , 1 , 1 , 0 , 0 , 0 , TimeSpan . FromHours ( 2 ) ) ;
var to = new DateTimeOffset ( 2023 , 1 , 3 , 23 , 59 , 59 , TimeSpan . FromHours ( 2 ) ) ;
var states = await client . StatesAsync ( "70173" , from , to ) ;
أو الساعات بالنسبة لهذه اللحظة:
var hoursInPast = 24 ;
var hoursInFuture = 48 ;
var states = client . States ( "70173" , hoursInPast , hoursInFuture ) ;
var hoursInPast = 24 ;
var hoursInFuture = 48 ;
var states = await client . StatesAsync ( "70173" , hoursInPast , hoursInFuture ) ;
إذا أرجعت واجهة برمجة التطبيقات خطأً، فستُرجع هذه الطريقة قائمة فارغة. يمكن أن يحدث هذا إذا كان الرمز البريدي غير صالح / غير مدعوم أو تم تجاوز الفترة المدعومة.
يمكنك جلب توقعات منطقة ما لفترة زمنية محددة عن طريق استدعاء أساليب Forecast
/ ForecastAsync
وتمرير الرمز البريدي للمنطقة ووقت البدء ووقت الانتهاء.
var from = new DateTimeOffset ( 2023 , 1 , 1 , 0 , 0 , 0 , TimeSpan . FromHours ( 2 ) ) ;
var to = new DateTimeOffset ( 2023 , 1 , 3 , 23 , 59 , 59 , TimeSpan . FromHours ( 2 ) ) ;
var forecast = client . Forecast ( "70173" , from , to ) ;
var from = new DateTimeOffset ( 2023 , 1 , 1 , 0 , 0 , 0 , TimeSpan . FromHours ( 2 ) ) ;
var to = new DateTimeOffset ( 2023 , 1 , 3 , 23 , 59 , 59 , TimeSpan . FromHours ( 2 ) ) ;
var forecast = await client . ForecastAsync ( "70173" , from , to ) ;
يمكنك تسجيل StromGedachtClient
في بدء التشغيل الخاص بك باستخدام HttpClient
المكتوب.
builder . Services . AddHttpClient < StromGedachtClient > ( ) ;
ثم قم بحقن العميل أينما تريد. على سبيل المثال في وحدة تحكم:
[ Route ( "Home" ) ]
[ ApiController ]
public class HomeController : ControllerBase
{
private readonly StromGedachtClient _client ;
public HomeController ( StromGedachtClient client )
{
_client = client ;
}
}
تقتصر واجهة برمجة التطبيقات على حوالي 6 طلبات في الدقيقة.
فيما يلي بعض المشاريع ذات الصلة:
يتم توفير واجهة برمجة التطبيقات (API) المستخدمة بواسطة شركة StromGedacht, TransnetBW GmbH.