تنزيل AkamaiOPEN edgegrid php client - AkamaiOPEN edgegrid php client Source Code

AkamaiOPEN edgegrid php client

فئات أخرى

Release 2.1.0

تنزيل

Akamai-Open/Edgegrid-Client

مصادقة Akamai Edgegrid لـ PHP

تتطلب هذه المكتبة PHP 8+ وتنفذ مخطط مصادقة Akamai Edgegrid أعلى Guzze كعميل بديل وبرامج وسيطة.

تثبيت

للتثبيت ، استخدم composer :

$ composer require akamai-open/edgegrid-client

طريقة التثبيت البديلة

قم بتنزيل ملف PHAR من صفحة الإصدارات وقم بتضمينه داخل الكود الخاص بك:

 ```php
include 'akamai-open-edgegrid-auth.phar';

// Library is ready to use
```

يستخدم

يمتد AkamaiOpenEdgeGridClient GuzzleHttpClient كبديل إسقاط. إنه يعمل بشفافية للتوقيع على طلبات API دون تغيير الطرق الأخرى التي تستخدمها.

لاستخدام العميل ، اتصل على AkamaiOpenEdgeGridClient->setAuth() أو تقديم مثيل AkamaiOpenEdgeGridAuthentication إلى المنشئ قبل تقديم طلب إلى واجهة برمجة التطبيقات.

 $ client = new Akamai  Open  EdgeGrid  Client ([
  ' base_uri ' => ' https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net '
]);

$ client -> setAuth ( $ client_token , $ client_secret , $ access_token );

// use $client just as you would GuzzleHttpClient
$ response = $ client -> get ( ' /identity-management/v3/user-profile ' );

المصادقة

لإنشاء بيانات الاعتماد الخاصة بك ، راجع إنشاء بيانات اعتماد المصادقة.

نوصي باستخدام ملف مصادقة .edgerc محلي. ضع بيانات الاعتماد الخاصة بك تحت عنوان [default] في الدليل المنزلي المحلي أو الدليل المنزلي لمستخدم خادم الويب.

 [default]
client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

يمكنك استدعاء ملف .edgerc واحدة من طريقتين:

استخدم طريقة المصنع AkamaiOpenEdgeGridClient::createFromEdgeRcFile() .

 $ client =  Akamai  Open  EdgeGrid Client:: createFromEdgeRcFile ();

// use $client just as you would GuzzleHttpClient
$ response = $ client -> get ( ' /identity-management/v3/user-profile ' );

حدد قسم بيانات الاعتماد و/أو .edgerc الموقع:

 $ client =  Akamai  Open  EdgeGrid Client:: createFromEdgeRcFile ( ' example ' , ' ../config/.edgerc ' );

// use $client just as you would GuzzleHttpClient
$ response = $ client -> get ( ' /identity-management/v3/user-profile ' );

واجهة سطر الأوامر

توفر هذه المكتبة واجهة سطر الأوامر (CLI) مع مجموعة محدودة من القدرات التي تحاكي HTTPIE.

ثَبَّتَ

قم بتثبيت CLI مع vendor/bin/http الملحن أو تنفيذ ملف PHAR.

 # Composer installed
$ ./vendor/bin/http --help

# For Windows
> php ./vendor/bin/http --help

# PHAR download
php akamai-open-edgegrid-client.phar --help

الحجج

يمكنك تعيين المصادقة وتحديد طريقة HTTP (غير حساسة للحالة) ، ورؤوسها ، وأي حقول جسم JSON.

ملاحظة: يعرض CLI لدينا جميع HTTP وبيانات الجسم. تم تشكيل JSON.

دعوى	وصف
`--auth-type={edgegrid,basic,digest}`	اضبط نوع المصادقة. الافتراضي هو `none` .
`--auth user:` أو `--a user:`	اضبط قسم `.edgerc` للاستخدام. على عكس `httpie-edgegrid` ، فإن القولون `:` :) اختياري.
`Header-Name:value`	الرؤوس والقيم هي القولون ( `:` مفصولة.
`jsonKey=value`	يرسل `{"jsonKey": "value"}` في `POST` أو `PUT` الجسم. سيؤدي ذلك أيضًا إلى تعيين `Content-Type` `Accept` الرؤوس إلى `application/json` .
`jsonKey:=[1,2,3]`	يسمح لك بتحديد بيانات RAW JSON ، وإرسال `{"jsonKey": [1, 2, 3]}` في الجسم.

القيود

لا يمكنك إرسال بيانات multipart/mime (تحميل الملف).
لا يتم دعم شهادات العميل.
لا يمكن التحقق من شهادات الخادم.
لا يمكن تخصيص الإخراج.
لا يتم تسليط الضوء على الاستجابات.

الوسيطة guzzle

توفر هذه الحزمة ثلاثة معالجات مختلفة للوسيط يمكنك إضافتها بشفافية عند استخدام Client ، إلى GuzzleHttpClient أو كمعالج قياسي.

The AkamaiOpenEdgeGridHandlerAuthentication لتوقيع طلب API شفاف.
The AkamaiOpenEdgeGridHandlerVerbose لاستجابات الإخراج (أو السجل).
The AkamaiOpenEdgeGridHandlerDebug لأخطاء الإخراج (أو السجل).

استخدام شفاف

معالج	يتصل
`Authentication`	`Client->setAuthentication()` أو تمرير في مثيل `AkamaiEdgeGridAuthentication` إلى `Client->__construct()` .
`Verbose`	`Client->setInstanceVerbose()` أو `Client::setVerbose()` يمر في `صحيح
`Debug`	`Client->setInstanceDebug()` أو `Client::setDebug()` أو تعيين خيار تكوين `debug` باستخدام `true

الوسيطة

معالج مثال

المصادقة

معالج	مثال
المصادقة	// Create the Authentication Handler $ auth = Akamai Open EdgeGrid Handler Authentication:: createFromEdgeRcFile (); // or: $ auth = new Akamai Open EdgeGrid Handler Authentication ; $ auth -> setAuth ( $ client_token , $ client_secret , $ access_token ); // Create the handler stack $ handlerStack = GuzzleHttp HandlerStack:: create (); // Add the Auth handler to the stack $ handlerStack -> push ( $ auth ); // Add the handler to a regular GuzzleHttpClient $ guzzle = new GuzzleHttp Client ([ " handler " => $ handlerStack ]);
مطول	// Create the handler stack $ handlerStack = HandlerStack:: create (); // Add the Auth handler to the stack $ handlerStack -> push ( new Akamai Open EdgeGrid Handler Verbose ()); // Add the handler to a regular GuzzleHttpClient $ guzzle = new GuzzleHttp Client ([ " handler " => $ handlerStack ]); `</td> </tr> <tr> <td>Debug</td> <td>` // Create the handler stack $ handlerStack = HandlerStack:: create (); // Add the Auth handler to the stack $ handlerStack -> push ( new Akamai Open EdgeGrid Handler Debug ()); // Add the handler to a regular GuzzleHttpClient $ guzzle = new GuzzleHttp Client ([ " handler " => $ handlerStack ]); `</td> </tr>`

 // Create the Authentication Handler
$ auth =  Akamai  Open  EdgeGrid  Handler Authentication:: createFromEdgeRcFile ();
// or:
$ auth = new  Akamai  Open  EdgeGrid  Handler  Authentication ;
$ auth -> setAuth ( $ client_token , $ client_secret , $ access_token );
// Create the handler stack
$ handlerStack =  GuzzleHttp HandlerStack:: create ();
// Add the Auth handler to the stack
$ handlerStack -> push ( $ auth );
// Add the handler to a regular GuzzleHttpClient
$ guzzle = new  GuzzleHttp  Client ([
" handler " => $ handlerStack
]);

مطول

 // Create the handler stack
$ handlerStack = HandlerStack:: create ();

// Add the Auth handler to the stack
$ handlerStack -> push ( new  Akamai  Open  EdgeGrid  Handler  Verbose ());

// Add the handler to a regular GuzzleHttpClient
$ guzzle = new  GuzzleHttp  Client ([
    " handler " => $ handlerStack
]);

  </td>
</tr>
<tr>
  <td>Debug</td>
  <td>

 // Create the handler stack
$ handlerStack = HandlerStack:: create ();

// Add the Auth handler to the stack
$ handlerStack -> push ( new  Akamai  Open  EdgeGrid  Handler  Debug ());

// Add the handler to a regular GuzzleHttpClient
$ guzzle = new  GuzzleHttp  Client ([
    " handler " => $ handlerStack
]);

  </td>
</tr>

رخصة

مرخصة بموجب ترخيص Apache ، الإصدار 2.0 ("الترخيص") ؛ لا يجوز لك استخدام هذا الملف إلا في الامتثال للترخيص. يمكنك الحصول على نسخة من الترخيص على http://www.apache.org/licenses/license-2.0.

ما لم يكن مطلوبًا بموجب القانون المعمول به أو الموافقة على الكتابة ، يتم توزيع البرامج الموزعة بموجب الترخيص على أساس "كما هي" ، دون ضمانات أو شروط من أي نوع ، إما صريحة أو ضمنية. راجع ترخيص الأذونات والقيود التي تحكم اللغة المحددة بموجب الترخيص.

يوسع

معلومات إضافية