Render - Get Copyright Caption

Layanan:

Maps

Versi API:

2024-04-01

Gunakan untuk mendapatkan informasi hak cipta yang akan digunakan saat merender petak peta.
API Get Copyright Caption adalah permintaan HTTP GET yang dirancang untuk melayani informasi hak cipta yang akan digunakan dengan petak peta yang diminta dari layanan Render. Selain hak cipta dasar untuk seluruh peta, ini dapat melayani kelompok hak cipta tertentu untuk beberapa negara/wilayah.

Sebagai alternatif untuk hak cipta untuk permintaan peta, ia juga dapat mengembalikan keterangan untuk menampilkan informasi penyedia di peta.

GET {endpoint}/map/copyright/caption/{format}?api-version=2024-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string
format	path	True	ResponseFormat	Format respons yang diinginkan. Nilai dapat berupa json atau xml .
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menunjukkan akun yang dimaksudkan untuk digunakan dengan model keamanan Microsoft Entra ID. ID unik untuk akun Azure Maps ini dapat diperoleh dari Azure Maps management plane Account API. Untuk informasi selengkapnya tentang menggunakan keamanan Microsoft Entra ID di Azure Maps, lihat Kelola autentikasi di Azure Maps.

Respons

Nama	Jenis	Deskripsi
200 OK	CopyrightCaption	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

AadToken

Ini adalah Aliran Microsoft Entra OAuth 2.0. Saat dipasangkan dengan kontrol akses berbasis peran Azure dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.\n\nUntuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini memberikan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.\n\n#### Catatan\n* Definisi keamanan memerlukan penggunaan header x-ms-client-id untuk menunjukkan sumber daya Azure Maps mana yang diminta aksesnya aplikasi. Ini dapat diperoleh dari Maps management API.\n* \nAuthorization URL khusus untuk instans cloud publik Azure. Cloud berdaulat memiliki URL Otorisasi dan konfigurasi Microsoft Entra ID yang unik. \n* \nKontrol akses berbasis peran Azure dikonfigurasi dari Azure management plane melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.\n* \nPenggunaan Azure Maps Web SDK memungkinkan penyiapan aplikasi berbasis konfigurasi untuk beberapa kasus penggunaan.\n* Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat ikhtisar platform identitas Microsoft.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Buat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.\n\n Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci utama di akun tempat mereka diterbitkan.\n\n Untuk aplikasi yang terekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: header

SAS Token

Ini adalah token tanda tangan akses bersama yang dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui sarana manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.\n\n Dengan token ini, aplikasi apa pun diizinkan untuk mengakses dengan Azure kontrol akses berbasis peran dan kontrol halus untuk kedaluwarsa, laju, dan wilayah yang digunakan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.\n\n Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan rendering dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

Successful Copyright Caption Request

Permintaan sampel

HTTP

GET {endpoint}/map/copyright/caption/json?api-version=2024-04-01

Respon sampel

Kode status:

200

{
  "copyrightsCaption": "© 1992 - 2022 TomTom.",
  "formatVersion": "0.0.1"
}

Definisi

Nama	Deskripsi
CopyrightCaption	Objek ini dikembalikan dari panggilan hak cipta yang berhasil
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
ResponseFormat	Format respons yang diinginkan. Nilai dapat berupa json atau xml .

CopyrightCaption

Objek

Objek ini dikembalikan dari panggilan hak cipta yang berhasil

Nama	Jenis	Deskripsi
copyrightsCaption	string	Properti Keterangan Hak Cipta
formatVersion	string	Properti Format Versi

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ResponseFormat

Enumerasi

Format respons yang diinginkan. Nilai dapat berupa json atau xml .

Nilai	Deskripsi
json	Format Pertukaran Data Notasi Objek JavaScript
xml	Bahasa Markup yang Dapat Diperluas