التخويل: ApiKey أو Credentials أو OAuth 2.0

حل GeoPard يستخدم AWS Cognito لإجراء المصادقة.

نوصي بمراجعة جميع خيارات التفويض. يعتمد الاختيار على حالة الاستخدام المحددة. يتم وصف مزيد من تفاصيل الاستخدام في كل خيار أدناه.

الخيار 1: استخدام بيانات الاعتماد

المصادقة باستخدام "اسم المستخدم" و"كلمة المرور" هي إحدى الطرق الممكنة. في هذه الحالة، يجب إجراء تسجيل عبر البريد الإلكتروني (دون استخدام الشبكات الاجتماعية).

النهج مستحسن للتكامل على مستوى واجهة برمجة التطبيقات (BackEnd) وجميع الطلبات إلى واجهة GeoPard API يتم توجيهها عبر خدمة مخصصة خاصة (مايكروسيرفيس).

طلب تسجيل الدخول

curl --location --request POST 'https://api.geopard.tech/login' \
--header 'Content-Type: application/json' \
--header 'Content-Type: text/plain' \
--data-raw '{"username":"<email_address>","password":"<password>"}'

استجابة تسجيل الدخول

الرمز هو JWT بعمر 30 دقيقة. من الممارسات الجيدة تخزين رمز واحد وإعادة استخدامه عبر جميع الطلبات، مع فحص وقت انتهاء صلاحيته وجلب رمز جديد عند انتهاء صلاحيته (أو قبل انتهاءه بفترة وجيزة).

{
    "token": "<token_to_use_in_geopard_api>"
}

الخيار 2: OAuth 2.0

يدعم AWS Cognito بروتوكول OAuth 2.0 للتفويض. يتم وصف النظرة العامة العامة في المقالة دليل Cognito OAuth2، الفرع الفرعي Authorization Code Grant هو الأكثر أهمية في حالة GeoPard.

النهج يوصى بتكامل GeoPard على مستوى واجهة المستخدم (FrontEnd). يعمل التكامل في كلا الاتجاهين لإرسال/استقبال البيانات إلى/من GeoPard.

باختصار:

1. يجب على تطبيقك إعادة توجيه المستخدم إلى Cognito الخاص بـ GeoPard لتسجيل الدخول أو التسجيل.

مثال:

curl --location --request GET '
https://auth.geopard.tech/oauth2/authorize?response_type=code&client_id=<connect_geopard_team>&redirect_uri=http://localhost:8080&state=54321
'

يرجى الاتصال بفريق GeoPard للحصول على client_id.

1. ستتلقى عنوان URL المعاد توجيهه رمز تحقق code للخطوة التالية.

يبدو عنوان URL المعاد توجيهه كما يلي http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. على تطبيقك أن يستبدل code لـ tokens (access_token, refresh_token, id_token).

مثال:

curl --location --request POST '
https://auth.geopard.tech/oauth2/token
' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: XSRF-TOKEN=365e14e1-3c66-477e-b0ef-a9e436a834ee; csrf-state=""; csrf-state-legacy=""' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a' \
--data-urlencode 'client_id=42ajne9u466in6gaf569nth9o9' \
--data-urlencode 'redirect_uri=
http://localhost:8080
'

الخيار 3: مفتاح واجهة برمجة التطبيقات

الوصول السريع إلى WMS و WFS ضروري من وقت لآخر. لذلك، من الممكن استخدام مفتاح واجهة برمجة تطبيقات GeoPard الذي يُنشأ تلقائيًا لكل حساب.

يمكن العثور على مفتاح واجهة برمجة التطبيقات في مفتاح_API الخاصية التابعة لكيان GraphQL "UserData". يتم توفير تعليمات حول كيفية استرجاع مفتاح_API مرفقة هنا.

مفتاح_API يجب استخدامه مع /geo نقاط النهاية فقط.

الاستخدام:

1. كـ geopardApiKey معامل في عنوان URL الخاص بطلب GET.

2. كـ X-API-Key رأس في أي طلب.