استدعاء واجهة برمجة التطبيقات

استدعاء واجهة برمجة التطبيقات

تنسيق الطلب

يتم ربط معظم العمليات المتاحة لإثبات ملكية الموقع الإلكتروني مباشرةً بأفعال REST HTTP (GET وPOST وPUT وDELETE)، كما هو موضّح في عمليات واجهة برمجة التطبيقات لإثبات ملكية المواقع الإلكترونية من Google.

التنسيق المحدد لمعرفات الموارد المنتظمة (URI) لواجهة برمجة تطبيقات التحقق من المواقع من Google هو:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

حيث resourceID هو معرِّف لمورد ويب، وتكون parameters هي أي معلمات يتم تطبيقها على طلب البحث. وتختلف المعلمات الفعلية التي تستخدمها حسب العملية التي تنفذها. بالإضافة إلى ذلك، إذا كنت تستخدم OAuth 2.0، عليك ضبط access_token في هذه المَعلمات.

لا تتطلّب طلبات البحث في القوائم resourceID، لذا يكون التنسيق كما يلي:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

يمكنك إجراء اتصالات بعملية getToken باستخدام معرّف الموارد المنتظم (URI) الفريد الخاص بها. تنسيق استدعاء getToken هو:

https://www.googleapis.com/siteVerification/v1/token?parameters

تنسيق البيانات

تعرض واجهة برمجة التطبيقات Google Site Verification API البيانات بتنسيق JSON.

JSON (JavaScript Object Notation) هو تنسيق بيانات شائع ومستقل عن اللغة ويقدم تمثيلاً نصيًا بسيطًا بُنى البيانات العشوائية. لمزيد من المعلومات، راجع json.org.

ملخّص العمليات

يمكنك استدعاء ست طرق مختلفة للمجموعات والموارد في Google Site Verification API، كما هو موضّح في الجدول التالي. ترتبط عناوين URL لواجهة برمجة التطبيقات بـ https://www.googleapis.com/siteVerification/v1.

أمثلة على طلبات البيانات من واجهة برمجة التطبيقات

يفترض هذا القسم أنّك (مطوّر البرامج) أنت المستخدم الذي تمت مصادقته، كما هو الحال عند تجربة واجهة برمجة التطبيقات لأول مرة مع بيانات الاختبار الخاصة بك.

إثبات ملكية موقع إلكتروني جديد

لإثبات ملكية موقع إلكتروني،

1. اطلب أولاً رمزًا مميّزًا لإثبات الملكية من خلال استدعاء getToken.
2. ضَع الرمز المميّز على موقعك الإلكتروني باستخدام أي طريقة تختارها.
3. اطلب من Google إثبات ملكيتك للموقع الإلكتروني باستخدام عملية إدراج.

getToken (يتطلب تفويض)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

الطلب:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

إدراج (يتطلب تفويض)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

الطلب:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

استرداد المعلومات لموارد الويب التي تم إثبات ملكيتها

يمكنك استرداد القائمة الكاملة لمواقعك ونطاقاتك التي تم إثبات ملكيتها من خلال طلب القائمة. يمكنك استرداد المعلومات لمورد ويب واحد من خلال طلب get.

قائمة (تتطلب تفويض)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

الطلب:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

الرد:

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

الحصول على (يتطلب تفويض)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الرد:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

تعديل معلومات إثبات الملكية

يمكنك تفويض الملكية أو إبطالها من خلال طلب تعديل. يمكنك إزالة الملكية لنفسك عن طريق طلب حذف.

تحديث (يتطلب تفويض)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

حذف (يتطلب تفويض)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الرد:

رمز حالة HTTP 204 (بدون محتوى)، مما يشير إلى نجاح العملية.