Bir konumu Apple Business Connect'e bağlayın

Parametreler

Gövde

Ad	Tür	Zorunlu	Açıklama
input	object	zorunlu	Wrapper object. The entire request body must be nested under `input`.
input.locationId	string	zorunlu	Location to connect. Accepts a Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.
input.site	string	zorunlu	Set to `APPLE`.
input.successUrl	string	zorunlu	Absolute URL in your application the owner returns to after granting access.
input.errorUrl	string	zorunlu	Absolute URL in your application the owner returns to if they cancel or the grant fails.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

Request body

{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "APPLE",    "successUrl": "https://app.example.com/locations/1800289/apple/connected",    "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed"  }}

Yanıtlar

200A single-use link to send the owner to. `errors` is `null` on success. The `url` shown is a placeholder; send the owner to the `url` returned in your own response.

Response

{  "data": {    "createConnectUrl": {      "success": true,      "url": "https://connect.example.com/oauth?token=8f3c1d92-...",      "errors": null    }  }}

401Unauthenticated, missing or invalid API key.

403The key is valid but not permitted to connect this location (`SY90003`).

İşletme sahibinin doğrulanmış bir Apple Business kuruluş hesabı varsa bunu kullanın. İşletme sahibini url adresine yönlendirin; işletme sahibi Apple Business Connect'te oturum açar, erişim izni verir ve successUrl adresinize geri döner. Bundan sonra ListingsAPI, bu konumun adını, kategorisini, adresini, telefon numarasını, web sitesini ve çalışma saatlerini işletme sahibinin hesabı üzerinden Apple Maps'te yayımlar. İşletme sahibi işlemi iptal ederse veya izin verme işlemi başarısız olursa errorUrl adresine geri döner ve hiçbir bağlantı kurulmaz.

İşletme sahibinin doğrulanmış bir Apple Business kuruluş hesabı yoksa bu çağrıyı atlayın. ListingsAPI, konumu kendi Apple Business Connect hesabı üzerinden yayımlar ve Apple, gönderimi yayımlamadan önce doğrular.

Apple, her bağlantıyla tek bir konumu bağlar. Birden fazla konumu bağlamak için her biri için bir bağlantı oluşturun. Her iki yönlendirme URL'si de mutlak olmalıdır; göreli veya ayrıştırılamayan bir değer, null url ile birlikte success: true olarak döner, bu nedenle yönlendirmeden önce url değerini kontrol edin. Bağlantı tek kullanımlıktır, bu nedenle her deneme için yeni bir bağlantı oluşturun.

Bağlantıyı doğrulayın

İşletme sahibi successUrl adresine geri döndükten sonra publisher=AppleAccount ile Bağlı hesapları listeleyin çağrısını yapın. status değerinin CONNECTED olması, güncellemelerin işletme sahibinin hesabı üzerinden yapıldığı anlamına gelir. MATCH_IN_PROGRESS veya CONNECTIVITY_ISSUE olması, işletme sahibinin yeni bir bağlanma bağlantısı açması gerektiği anlamına gelir.

İşletme sahibinin hesabı üzerinden yayımlamayı durdurmak için Bir konumun Apple Business Connect bağlantısını kesin işlemini kullanın. Apple Maps işletme kaydının nasıl kontrol edileceği de dahil olmak üzere tüm akış için Apple Business Connect'i bağlayın sayfasına bakın.

Bu sayfa, Tek bir konum için OAuth bağlantı URL'si oluşturun işleminin site: "APPLE" durumunu belgeler.

Bu uç nokta, canlı ortamda kullanılabilen OAuth kimlik bilgileri oluşturur. Yukarıdaki örnek istek ve yanıt, örnek niteliğindedir.

curl -X POST 'https://listingsapi.com/api/v4/locations/oauth_connect_url' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" } }'