مكتبة Typescript لاستخدام StromGedacht API
متاح على npm.
npm install ts-stromgedacht
يمكن للعميل تقديم حالة المنطقة في الوقت الحالي أو جميع الولايات لفترة زمنية معينة.
قد تمتد الفترة بحد أقصى يومين في المستقبل و4 أيام في الماضي.
في كل مرة تقوم فيها بتقديم طلب، سوف تحتاج إلى تقديم الرمز البريدي للمنطقة التي تريد طلب الولاية الخاصة بها.
نظرًا لأن واجهة برمجة التطبيقات (API) تسمح بجميع الأصول، فيمكن استخدام هذه المكتبة في المتصفح دون أخطاء CORS.
فقط قم باستيراد العميل من العقدة الخاصة بك.
import { stromgedachtClient } from "ts-stromgedacht" ;
يمكنك جلب الحالة الحالية للمنطقة عن طريق استدعاء الأسلوب Now
وتمرير الرمز البريدي للمنطقة.
const state = await stromgedachtClient . now ( "70173" ) ;
إذا أرجعت واجهة برمجة التطبيقات خطأً، فستُرجع هذه الطريقة null
. يمكن أن يحدث هذا إذا كان الرمز البريدي غير صالح / غير مدعوم.
يمكنك جلب جميع ولايات المنطقة لفترة زمنية محددة عن طريق استدعاء طريقة States
وتمرير الرمز البريدي للمنطقة ووقت البدء ووقت الانتهاء.
const from = new Date ( "2023-01-01" ) ;
const to = new Date ( "2023-01-03" ) ;
const states = stromgedachtClient . states ( "70173" , from , to ) ;
يمكن أيضًا أن يكون وقت البدء والانتهاء هو الساعات المرتبطة بهذه اللحظة:
const hoursInPast = 24 ;
const hoursInFuture = 48 ;
const states = stromgedachtClient . statesRelative ( "70173" , hoursInPast , hoursInFuture ) ;
إذا أرجعت واجهة برمجة التطبيقات خطأً، فستُرجع هذه الطريقة مصفوفة فارغة. يمكن أن يحدث هذا إذا كان الرمز البريدي غير صالح / غير مدعوم أو تم تجاوز الفترة المدعومة.
يمكنك جلب توقعات المنطقة لفترة زمنية محددة عن طريق استدعاء طرق forecast
وتمرير الرمز البريدي للمنطقة ووقت البدء ووقت الانتهاء.
const from = new Date ( "2023-01-01" ) ;
const to = new Date ( "2023-01-03" ) ;
const forecast = stromgedachtClient . forecast ( "70173" , from , to ) ;
تقتصر واجهة برمجة التطبيقات على حوالي 6 طلبات في الدقيقة.
فيما يلي بعض المشاريع ذات الصلة:
يتم توفير واجهة برمجة التطبيقات (API) المستخدمة بواسطة شركة StromGedacht, TransnetBW GmbH.