/api/v4/locations/oauth_connect_urlHubungkan lokasi ke Apple Business Connect
Membuat tautan OAuth Apple Business Connect agar ListingsAPI memublikasikan satu lokasi ke Apple Maps melalui akun Apple Business pemilik terverifikasi.
Parameter
Body
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| input | object | wajib | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | wajib | Location to connect. Accepts a Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
| input.site | string | wajib | Set to `APPLE`. |
| input.successUrl | string | wajib | Absolute URL in your application the owner returns to after granting access. |
| input.errorUrl | string | wajib | Absolute URL in your application the owner returns to if they cancel or the grant fails. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" }}Respons
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.
{ "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`).
Gunakan ini jika pemilik bisnis memiliki akun organisasi Apple Business yang telah diverifikasi. Arahkan pemilik ke url; mereka masuk ke Apple Business Connect, memberikan akses, lalu kembali ke successUrl Anda. Sejak saat itu, ListingsAPI memublikasikan nama, kategori, alamat, nomor telepon, situs web, dan jam operasional lokasi tersebut ke Apple Maps melalui akun pemilik. Jika mereka membatalkan atau pemberian akses gagal, mereka kembali ke errorUrl dan tidak ada yang terhubung.
Jika pemilik tidak memiliki akun organisasi Apple Business yang telah diverifikasi, lewati panggilan ini. ListingsAPI memublikasikan lokasi melalui akun Apple Business Connect miliknya sendiri, dan Apple memverifikasi pengajuan tersebut sebelum memublikasikannya.
Apple menghubungkan satu lokasi per tautan. Untuk menghubungkan beberapa lokasi, buat tautan untuk setiap lokasi. Kedua URL pengalihan harus berupa URL absolut; nilai relatif atau yang tidak dapat diurai akan dikembalikan sebagai success: true dengan null url, jadi periksa url sebelum mengalihkan. Tautan hanya dapat digunakan sekali, jadi buat tautan baru untuk setiap percobaan.
Konfirmasikan koneksi
Setelah pemilik kembali ke successUrl, panggil Daftar akun yang terhubung dengan publisher=AppleAccount. Nilai status berupa CONNECTED berarti pembaruan dilakukan melalui akun pemilik. MATCH_IN_PROGRESS atau CONNECTIVITY_ISSUE berarti pemilik harus membuka tautan koneksi baru.
Untuk berhenti memublikasikan melalui akun pemilik, gunakan Putuskan koneksi lokasi dari Apple Business Connect. Untuk alur lengkap, termasuk cara memeriksa profil bisnis di Apple Maps, lihat Hubungkan Apple Business Connect.
Halaman ini mendokumentasikan kasus site: "APPLE" dari Buat URL koneksi OAuth untuk satu lokasi.
Endpoint ini membuat kredensial OAuth yang aktif. Permintaan dan respons sampel di atas merupakan contoh.
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" } }'