مستندات API

قابلیت‌های قدرتمند مسیریابی و برنامه‌ریزی خودروی برقی ABRP را در پلتفرم خودت ادغام کن. مجموعه جامع API ما ادغام یکپارچه مسیریابی آگاه از خودرو، تله‌متری و ویژگی‌های پیوند عمیق را ممکن می‌کند.

APIها و ادغام

برای ادغام مسیریابی خودروی برقی، تله‌متری و پیوند عمیق در پلتفرم خودت، به مجموعه APIهای ما دسترسی پیدا کن.

API برنامه‌ریزی

v2 - توصیه‌شده

v1 - قدیمی

مسیریابی آگاه از خودرو با قابلیت‌های جامع برنامه‌ریزی خودروی برقی

API برنامه‌ریزی ما برنامه‌ریزی مسیر پیشرفته‌ای ارائه می‌دهد که همگام با بهبودهای مستمر ABRP تکامل می‌یابد. ویژگی‌ها شامل مدل‌سازی مصرف انرژی، بهینه‌سازی شارژ، ادغام ترافیک بلادرنگ و برنامه‌ریزی آگاه از آب و هوا هستند.

این API از معماری REST با خروجی JSON استفاده می‌کند و از هر دو نقطهٔ پایانی قدیمی (v1) و مدرن (v2) پشتیبانی می‌کند. هزینه‌های راه‌اندازی و قیمت هر طرح بسته به نیازهای ادغام و حجم استفاده‌ات متفاوت است.

مستندات برنامه‌ریزی v2 مستندات برنامه‌ریزی v1 (قدیمی)

Telemetry API

داده‌های بلادرنگ خودرو برای ردیابی زنده و مدل‌سازی خودرو

API تله‌متری انتقال بلادرنگ داده‌های خودرو را برای ردیابی زنده سفر، تحلیل مصرف و بهبود مستمر مدل‌های خودروی ما ممکن می‌کند. این به ما کمک می‌کند پیش‌بینی‌های انرژی و دقت مسیریابی را پالایش کنیم.

کلیدهای API رایگان برای ادغام در دسترس هستند. توکن‌های کاربر برای ارسال داده‌ها لازم‌اند و می‌توان آن‌ها را از طریق جریان OAuth2 (توصیه‌شده) یا بازیابی دستی توکن برای آزمایش و توسعه به‌دست آورد.

مستندات تله‌متری کلیدهای API تله‌متری‌ات را مدیریت کن

OAuth2 API

احراز هویت و مجوزدهی امن کاربر

OAuth2 راهی امن و راحت برای شناسایی و احراز هویت کاربران با Iternio فراهم می‌کند. برای راه‌اندازی OAuth2 به یک کلید API نیاز داری و باید یک URL تغییر مسیر و نام اپلیکیشن ارائه بدهی.

جریان مجوزدهی

اولین فراخوانی یک صفحهٔ HTML برمی‌گرداند که در آن کاربران می‌توانند وارد شوند و اپلیکیشن تو را تأیید کنند. اگر در مرورگر پیش‌فرض کاربر باز شود، ممکن است برای ساده‌تر شدن فرایند، ورودشان در حافظه پنهان ذخیره شود.

https://abetterrouteplanner.com/oauth/auth?client_id=<your_client_id>&scope=<requested_scope>&response_type=code&redirect_uri=<your_redirect_uri>

محدوده‌های مجاز:

get_telemetry: بازیابی آخرین تله‌متری کاربر
set_telemetry: ارسال به‌روزرسانی‌های تله‌متری جدید به خودرو
get_plan: دریافت آخرین طرح به‌صورت فشرده (برای جزئیات با ما تماس بگیر)
vehicle_history: بازیابی رانندگی‌ها و جلسات شارژ گذشته (برای جزئیات با ما تماس بگیر)

پاسخ در URI تغییر مسیر تو:

https://your_redirect_uri?state=<state_provided>&auth_code=<returned_auth_code>

بازیابی توکن

وقتی یک کد مجوز دریافت کردی، توکن را بازیابی کن که در صورت نیاز قابل ذخیره و استفادهٔ مجدد است.

https://api.iternio.com/1/oauth/token?client_id=<your_client_id>&client_secret=<your_api_key>&code=<auth_code>

فرمت پاسخ:

{
  "access_token": "<the created token>",
  "token_type": "bearer",
  "state": "<your supplied state>"
}

اطلاعات کاربر

پس از به‌دست آوردن توکن، از نقطهٔ پایانی «me» برای بازیابی اطلاعات کاربر استفاده کن:

https://api.iternio.com/1/oauth/me?access_token=<the user token>&api_key=<your api key>

فرمت پاسخ:

{
  "user_id": <the numeric ID of the user>,
  "full_name": "<Full name of the user>",
  "email": "<Email of user>",
  "vehicle_id": <The numeric ID of the vehicle, if part of the scope>,
  "vehicle_name": "<The vehicle name>",
  "vehicle_typecode": "<The vehicle typecode>"
}

پیوندهای عمیق

ادغام مبتنی بر URL برای برنامه‌ریزی مسیر از‌پیش‌پیکربندی‌شده

URLهای سفارشی بساز که ABRP را با مسیرهای از‌پیش‌پیکربندی‌شده، انتخاب خودرو و پارامترهای برنامه‌ریزی راه‌اندازی می‌کنند. ایده‌آل برای جاسازی در اپ‌ها، وب‌سایت‌ها یا سیستم‌های ناوبری بدون ادغام API.

پیوندهای عمیق از طیف وسیعی از پارامترهای URL پشتیبانی می‌کنند، از جمله مختصات مبدأ/مقصد، نقاط بین‌راهی، مدل‌های خودرو، وضعیت شارژ و ترجیحات کاربر. URL پایه: https://abetterrouteplanner.com

مستندات پیوندهای عمیق