Pengenalan Api Pengenalan Awan

Api lengkap

Protokol antarmuka Rest Api dan mekanisme otentikasi

Crs Api mengikuti standar transmisi Http Rest standar.

Http Header

Authorization:

Parameter permintaan Http, dibagi menjadi dua jenis:

Parameter umum (termasuk ini secara total, metode otentikasi yang berbeda menggunakan kombinasi yang berbeda):
- appId
- timestamp (Long integer: milidetik yang telah berlalu sejak 1 Januari 1970 00:00:00 UTC)
- apiKey
- signature (tanda tangan permintaan, pilih satu dari dua metode otentikasi token)
Parameter Crs Api: parameter Api itu sendiri

Dokumentasi Api tidak lagi menggambarkan parameter umum untuk otentikasi

Otentikasi Api Key

Metode otentikasi dibagi menjadi dua jenis:

Otentikasi berbasis Token

Header Http Authorization berisi Token, parameter umum termasuk:

appId

Otentikasi tanda tangan

Tidak menggunakan header Http Authorization.

Parameter umum berisi informasi tanda tangan signature. Semua parameter dimasukkan dalam perhitungan tanda tangan (kecuali gambar).

appId
timestamp
apiKey
signature

Untuk algoritma dan kode rinci perhitungan tanda tangan, silakan merujuk ke dokumentasi Metode tanda tangan Api Key.

Contoh penggunaan dan analisis properti

Contoh penggunaan Api

Di sini, melalui contoh—memanggil antarmuka Api untuk membuat gambar target, membantu pengembang melihat sekilas proses permintaan Crs Api, memahami struktur properti gambar target, serta input dan output antarmuka.

Sebelum membuat gambar target di lingkungan produksi, lebih banyak verifikasi diperlukan, silakan merujuk ke Praktik terbaik untuk membuat gambar target baru.

Contoh permintaan

Tambahkan file gambar target test-target.jpg. Saat membuat gambar target, file gambar perlu dikodekan base64.

Dokumentasi Api akan memberikan penjelasan rinci tentang parameter permintaan. Lihat Api — Membuat gambar target, file gambar yang dikodekan base64 meminta Api.

POST /targets HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
    "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
    "active":"1",
    "name":"easyar",
    "size":"5",
    "meta":"496fbbabc2b38ecs3460a...",
    "type":"ImageTarget",
    "timestamp": 1514736000000,
    "apiKey": "8b485c648c3056e79c2a85ee9b51f9dc",
    "appId": "C:CN1:f9f903c36da8bd64d71d491077bba...",
    "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}

Contoh respons

HTTP/1.1 200 OK
Content-Type: application/json
{
    "statusCode": 0,
    "result": {
        "targetId":"e61db301-e80f-4025-b822-9a00eb48d8d2",
        "trackingImage":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM..."，
        "name": "easyar",
        "size": "5",
        "meta": "496fbbabc2b38ecs3460a...",
        "type": "ImageTarget",
        "modified":1514735000000
        "active":"1"，
        "trackableRate": 0,
        "detectableRate": 0,
        “detectableDistinctiveness”：0,
        "detectableFeatureCount": 0,
        "trackableDistinctiveness": 0,
        "trackableFeatureCount": 0,
        "trackableFeatureDistribution": 0,
        "trackablePatchContrast": 0,
        "trackablePatchAmbiguity": 0
    },
    "timestamp": 1514736000000
}

Format respons

Respons menggunakan format yang seragam. Berikut adalah contohnya:

{
  "statusCode": 119,
  "msg": "Parameter has errors",
  "date": "2022-06-15T09:56:30.000Z",
  "result":  //hanya ada result jika statusCode adalah 0, jika terjadi kesalahan, bidang hasil kosong
}

Seperti yang ditunjukkan pada contoh di atas, ini adalah struktur detail gambar target yang dikembalikan secara normal. Sebuah gambar target mencakup properti berikut

Properti	Deskripsi
targetId	Id unik gambar target
trackingImage	Pengkodean base64 gambar skala abu-abu yang diproses, digunakan untuk pelacakan gambar di perangkat
name	Nama gambar target
size	Ukuran gambar, ukuran yang digunakan untuk menumpangkan konten virtual dalam aplikasi
meta	Data terkait pengguna, dapat berupa file, teks, atau url, perlu dikodekan base64
type	"ImageTarget"
active	Hanya gambar target yang diaktifkan yang dapat dikenali, setelah dinonaktifkan tidak akan dikenali
trackableRate	Peringkat kesulitan pelacakan, semakin kecil semakin baik
detectableRate	Peringkat kesulitan pengenalan komprehensif, semakin kecil semakin baik
detectableDistinctiveness	Peringkat kesulitan keterbedaan pengenalan, semakin kecil semakin baik
detectableFeatureCount	Peringkat kesulitan aspek fitur pengenalan, semakin kecil semakin baik
trackableDistinctiveness	Peringkat kesulitan keterbedaan pelacakan, semakin kecil semakin baik
trackableFeatureCount	Peringkat kesulitan aspek fitur pelacakan, semakin kecil semakin baik
trackableFeatureDistribution	Peringkat kesulitan distribusi fitur pelacakan, semakin kecil semakin baik

Kode kesalahan

Penjelasan kode kesalahan Api Pengenalan Awan

Table of Contents