Kodlarınızı öz sisteminizdən idarə edin.
Yüzlərlə QR kodu bir sorğu ilə yaradın, hədəflərini yeniləyin, skan hesabatlarını öz panelinizə çəkin. REST, JSON və bir API açarı kifayətdir.
Qaralama — endpoint-lər hazırlanma zamanı dəqiqləşəcək. Bu səhifə təklif olunan strukturu göstərir; işlək API hələ yoxdur. Ünvanlar, sahə adları, limitlər və cavab formatları dəyişə bilər.
- Əsas ünvan
https://api.oqur.io/v1- Format
- JSON, UTF-8, HTTPS
- Autentifikasiya
- Bearer API açarı
- Planlar
- Biznes və Korporativ
Başlanğıc
oqur API paneldə etdiyiniz işləri öz proqramınızdan etməyə imkan verir: kütləvi QR yaratma, hədəfi yeniləmə, çap faylı endirmə və skan hesabatları. Bütün sorğular HTTPS üzərindən, JSON gövdə ilə edilir.
Açar yaradın
Paneldə «Tənzimləmələr» menyusundakı «API açarları» bölməsindən açar yaradın və icazələrini seçin. API hazır olanda Biznes və Korporativ planlarda açılacaq.
İlk sorğunuzu göndərin
Yandakı nümunə hesabınızdakı ilk kodu siyahıya alır. Cavab 200-dürsə, hər şey hazırdır.
Limitləri izləyin
Qalan sorğu sayınız hər cavabın başlıqlarında yazılır. Təfərrüatlar Sürət limitləri bölməsindədir.
Qaydalar
| Mövzu | Format | Təsvir |
|---|---|---|
| Tarix və saat | ISO 8601 |
Həmişə UTC ilə qayıdır: 2026-09-30T09:12:44Z. Hesabatlarda istədiyiniz saat qurşağını seçə bilərsiniz. |
| İdentifikatorlar | string |
Prefiksli mətn: QR kodlar qr_, qovluqlar fld_, sorğular req_ ilə başlayır. |
| Səhifələmə | integer |
page və per_page ilə. Səhifədə ən çox 100 qeyd. |
| Versiya | v1 |
Ünvandakı versiya. Geriyə uyğun olmayan dəyişikliklər yalnız yeni versiya ilə gəlir. |
curl "https://api.oqur.io/v1/qr-codes?per_page=1" \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Accept: application/json"
<?php
// composer require guzzlehttp/guzzle
use GuzzleHttp\Client;
$oqur = new Client([
'base_uri' => 'https://api.oqur.io/v1/',
'headers' => [
'Authorization' => 'Bearer ' . getenv('OQUR_API_KEY'),
'Accept' => 'application/json',
],
]);
$res = $oqur->get('qr-codes', ['query' => ['per_page' => 1]]);
$body = json_decode($res->getBody(), true);
// Node 18+ və ya brauzerdən kənar mühitlər
const oqur = (path, init = {}) =>
fetch(`https://api.oqur.io/v1${path}`, {
...init,
headers: {
Authorization: `Bearer ${process.env.OQUR_API_KEY}`,
'Content-Type': 'application/json',
Accept: 'application/json',
...init.headers,
},
}).then((r) => r.json());
const body = await oqur('/qr-codes?per_page=1');
Cavab 200 NÜMUNƏ
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "menu",
"name": "Kafe Rıhtım · Masa kartı",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"created_at": "2026-09-12T08:30:00Z"
}
],
"meta": { "page": 1, "per_page": 1, "total": 42 }
}
Autentifikasiya
Hər sorğuya Authorization başlığında API açarınızı əlavə edin. Açarsız və ya etibarsız açarlı sorğular 401, icazəsi çatmayan açarlar 403 qaytarır.
- Açarı yalnız server tərəfində istifadə edin; brauzerə və ya mobil tətbiqə yerləşdirməyin.
- Hər inteqrasiya üçün ayrıca açar yaradın. Biri sızsa, yalnız onu ləğv edirsiniz.
- Açara yalnız lazım olan icazələri verin:
qr:read,qr:write,analytics:read,folders:write.
Başlıqlar
| Başlıq | Növ | Təsvir |
|---|---|---|
Authorizationməcburi |
string |
Bearer və ardınca API açarınız. |
Content-Type |
string |
Gövdəli sorğularda application/json. |
Accept |
string |
application/json. |
Idempotency-Key |
string |
Yaratma sorğularını təhlükəsiz təkrarlamaq üçün unikal dəyər. Eyni açarla 24 saat ərzində gələn sorğu ilk cavabı qaytarır. |
Sorğu başlıqlarıNÜMUNƏ
Authorization: Bearer oqur_live_8f3kQ2…
Content-Type: application/json
Accept: application/json
Cavab 401 NÜMUNƏ
{
"error": {
"code": "unauthenticated",
"message": "API açarı yoxdur və ya etibarsızdır.",
"request_id": "req_5nT2pW"
}
}
Sürət limitləri
Hər API açarı dəqiqədə 60 sorğu edə bilər; Korporativ planda limit ehtiyaca görə müəyyən olunur. Kütləvi endpoint-lər bir sorğuda 100 element emal edir, yəni dəqiqədə 6000 kodadək yarada və ya redaktə edə bilərsiniz.
Cavab başlıqları
| Başlıq | Növ | Təsvir |
|---|---|---|
X-RateLimit-Limit |
integer |
Dəqiqəlik ümumi sorğu limitiniz. |
X-RateLimit-Remaining |
integer |
Bu dəqiqə üçün qalan sorğu. |
X-RateLimit-Reset |
integer |
Limitin yenilənəcəyi an, Unix vaxt möhürü. |
Retry-After |
integer |
Yalnız 429 cavabında: neçə saniyə gözləməli olduğunuz. |
429 aldıqda Retry-After qədər gözləyib yenidən cəhd edin. Ardıcıl xətalarda gözləmə müddətini hər cəhddə iki dəfə artırmaq ən təhlükəsiz yoldur.
Cavab 429 NÜMUNƏ
HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1790759580
Retry-After: 18
{
"error": {
"code": "rate_limited",
"message": "Dəqiqəlik sorğu limitiniz doldu. 18 saniyə sonra yenidən cəhd edin.",
"request_id": "req_9kP1sV"
}
}
QR kodlar
Kod yaratma, redaktə və çap faylı hazırlama. Dinamik kodun hədəfini dəyişmək qısa keçidi dəyişmir: çap olunmuş kod eyni qalır.
Kütləvi yarat
POST
/qr-codes/bulk
Bir sorğuda ən çox 100 QR kod yaradır. Hər element ayrıca yoxlanılır; etibarsız element varsa, heç biri yaradılmır və xətalar element sırası ilə qayıdır.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:write
Başlıqlar
| Başlıq | Növ | Təsvir |
|---|---|---|
Idempotency-Key |
string |
Sorğunu təhlükəsiz təkrar göndərmək üçün unikal dəyər. |
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
itemsməcburi |
array |
Yaradılacaq kodlar. Ən azı 1, ən çox 100 element. |
items[].typeməcburi |
string |
QR növü: url, pdf, menu, vcard-plus, wifi kimi 24 növdən biri. |
items[].targetməcburi |
object |
Növə görə dəyişən hədəf. url növündə url sahəsi, pdf növündə file_url sahəsi. |
items[].name |
string |
Paneldə görünən ad. Ən çox 120 simvol. |
items[].folder_id |
string |
Kodun əlavə olunacağı qovluq. |
items[].design |
object |
Rəng, naxış, künc, loqo və çərçivə. Boş buraxsanız, hesabınızın defolt şablonu istifadə olunur. |
Q5 xəttindəki növlər (wifi, text, vcard, email, sms, whatsapp) statik yaradılır və dinamik kod kvotanızdan çıxılmır.
Status kodları
- 201 Kodlar yaradıldı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 403 Planınız API-yə və ya bu qədər dinamik koda icazə vermir.
- 422 Bir və ya bir neçə element etibarsızdır; təfərrüatlar details massivindədir.
- 429 Sürət limitinə çatdınız; Retry-After qədər gözləyin.
curl -X POST https://api.oqur.io/v1/qr-codes/bulk \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: campaign-september-01" \
-d '{
"items": [
{
"type": "url",
"name": "Afişa · Kadıköy",
"target": { "url": "https://cafename.com/campaign" },
"folder_id": "fld_91xQ"
},
{
"type": "pdf",
"name": "Katalog 2026",
"target": { "file_url": "https://kafeadi.com/katalog.pdf" }
}
]
}'
<?php
// $oqur: «Başlanğıc» bölməsindəki müştəri
$res = $oqur->post('qr-codes/bulk', [
'headers' => ['Idempotency-Key' => 'campaign-september-01'],
'json' => [
'items' => [
[
'type' => 'url',
'name' => 'Afişa · Kadıköy',
'target' => ['url' => 'https://cafename.com/campaign'],
'folder_id' => 'fld_91xQ',
],
[
'type' => 'pdf',
'name' => 'Katalog 2026',
'target' => ['file_url' => 'https://kafeadi.com/katalog.pdf'],
],
],
],
]);
// oqur(): «Başlanğıc» bölməsindəki köməkçi
const { data } = await oqur('/qr-codes/bulk', {
method: 'POST',
headers: { 'Idempotency-Key': 'campaign-september-01' },
body: JSON.stringify({
items: [
{
type: 'url',
name: 'Afişa · Kadıköy',
target: { url: 'https://cafename.com/campaign' },
folder_id: 'fld_91xQ',
},
{
type: 'pdf',
name: 'Katalog 2026',
target: { file_url: 'https://kafeadi.com/katalog.pdf' },
},
],
}),
});
Cavab 201 NÜMUNƏ
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "url",
"name": "Afişa · Kadıköy",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"folder_id": "fld_91xQ",
"created_at": "2026-09-30T09:12:44Z"
},
{
"id": "qr_8Lr3nY",
"type": "pdf",
"name": "Katalog 2026",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/8Lr3nQ",
"folder_id": null,
"created_at": "2026-09-30T09:12:44Z"
}
],
"meta": { "created": 2 }
}
Kütləvi redaktə
PATCH
/qr-codes/bulk
Bir sorğuda ən çox 100 kodu yeniləyir. Yalnız göndərdiyiniz sahələr dəyişir; qısa keçid və çap olunmuş kod eyni qalır.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:write
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
itemsməcburi |
array |
Yenilənəcək kodlar. Ən azı 1, ən çox 100 element. |
items[].idməcburi |
string |
Kodun identifikatoru. |
items[].target |
object |
Yeni hədəf. Növbəti skanlar dərhal yeni hədəfə gedir. |
items[].status |
string |
active və ya paused. Dayandırılmış kodu skan edənlər sadə «müvəqqəti bağlıdır» səhifəsi görür. |
items[].name |
string |
Yeni ad. |
items[].folder_id |
string |
Köçürüləcəyi qovluq; qovluqdan çıxarmaq üçün null. |
items[].design |
object |
Dizayn sahələri. Göndərdiyiniz alt sahələr birləşdirilir. |
Status kodları
- 200 Kodlar yeniləndi.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Siyahıdakı kod tapılmadı və ya sizə aid deyil.
- 422 Element etibarsızdır; heç bir kod yenilənmədi.
- 429 Sürət limitinə çatdınız.
curl -X PATCH https://api.oqur.io/v1/qr-codes/bulk \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "id": "qr_7Kq2mX", "target": { "url": "https://kafeadi.com/ekim" } },
{ "id": "qr_8Lr3nY", "status": "paused" }
]
}'
<?php
$res = $oqur->patch('qr-codes/bulk', [
'json' => [
'items' => [
['id' => 'qr_7Kq2mX', 'target' => ['url' => 'https://kafeadi.com/ekim']],
['id' => 'qr_8Lr3nY', 'status' => 'paused'],
],
],
]);
const { data } = await oqur('/qr-codes/bulk', {
method: 'PATCH',
body: JSON.stringify({
items: [
{ id: 'qr_7Kq2mX', target: { url: 'https://kafeadi.com/ekim' } },
{ id: 'qr_8Lr3nY', status: 'paused' },
],
}),
});
Cavab 200 NÜMUNƏ
{
"data": [
{ "id": "qr_7Kq2mX", "status": "active", "updated_at": "2026-09-30T10:04:12Z" },
{ "id": "qr_8Lr3nY", "status": "paused", "updated_at": "2026-09-30T10:04:12Z" }
],
"meta": { "updated": 2 }
}
Siyahı
GET
/qr-codes
Hesabınızdakı kodları səhifələrlə qaytarır. Defolt sıralama ən yenidən köhnəyə.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:read
Sorğu parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
page |
integer |
Səhifə nömrəsi. Defolt 1. |
per_page |
integer |
Səhifədə qeyd. Defolt 25, ən çox 100. |
folder_id |
string |
Yalnız bu qovluqdakı kodlar. |
type |
string |
Növə görə filtr, məsələn menu. |
status |
string |
draft, scheduled, active və ya paused. |
search |
string |
Adda və ya qısa keçiddə axtarır. |
sort |
string |
created_at, name və ya scans_total. Azalan sıra üçün əvvəlinə mənfi qoyun: -scans_total. |
Status kodları
- 200 Siyahı qayıtdı; nəticə yoxdursa, data boş massivdir.
- 401 API açarı yoxdur və ya etibarsızdır.
- 422 Etibarsız filtr və ya sıralama dəyəri.
curl -G https://api.oqur.io/v1/qr-codes \
-H "Authorization: Bearer $OQUR_API_KEY" \
-d folder_id=fld_91xQ \
-d status=active \
-d sort=-scans_total \
-d per_page=25
<?php
$res = $oqur->get('qr-codes', ['query' => [
'folder_id' => 'fld_91xQ',
'status' => 'active',
'sort' => '-scans_total',
'per_page' => 25,
]]);
const params = new URLSearchParams({
folder_id: 'fld_91xQ',
status: 'active',
sort: '-scans_total',
per_page: '25',
});
const { data, meta } = await oqur(`/qr-codes?${params}`);
Cavab 200 NÜMUNƏ
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "url",
"name": "Afişa · Kadıköy",
"status": "active",
"short_url": "https://oqur.io/d/7Kq2xP",
"scans_total": 312,
"created_at": "2026-09-12T08:30:00Z"
}
],
"meta": { "page": 1, "per_page": 25, "total": 1 },
"links": { "next": null, "prev": null }
}
Al
GET
/qr-codes/{id}
Bir kodun bütün sahələrini qaytarır: hədəf, dizayn, status və ümumi skan sayı.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:read
Yol parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idməcburi |
string |
Kodun identifikatoru, məsələn qr_7Kq2mX. |
Status kodları
- 200 Kod tapıldı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Kod yoxdur və ya sizə aid deyil.
curl https://api.oqur.io/v1/qr-codes/qr_7Kq2mX \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->get('qr-codes/qr_7Kq2mX');
$code = json_decode($res->getBody(), true)['data'];
const { data: code } = await oqur('/qr-codes/qr_7Kq2mX');
Cavab 200 NÜMUNƏ
{
"data": {
"id": "qr_7Kq2mX",
"type": "url",
"name": "Afişa · Kadıköy",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"target": { "url": "https://cafename.com/campaign" },
"folder_id": "fld_91xQ",
"design": {
"foreground": "#0B1F3A",
"background": "#FFFFFF",
"dots": "rounded",
"corners": "square",
"logo_url": null,
"frame": { "style": "bottom", "text": "Beni tara" },
"error_correction": "M"
},
"scans_total": 312,
"created_at": "2026-09-12T08:30:00Z",
"updated_at": "2026-09-28T17:02:10Z"
}
}
Yenilə
PATCH
/qr-codes/{id}
Bir kodu yeniləyir. Hədəfi dəyişmək kodu dəyişmir: çap olunmuş QR eyni qalır, növbəti skanlar yeni hədəfə gedir.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:write
Yol parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idməcburi |
string |
Kodun identifikatoru. |
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
target |
object |
Yeni hədəf. Statik kodlarda dəyişdirilə bilməz. |
status |
string |
active və ya paused. |
name |
string |
Yeni ad. |
folder_id |
string |
Köçürüləcəyi qovluq; qovluqdan çıxarmaq üçün null. |
design |
object |
Dizayn sahələri. Göndərdiyiniz alt sahələr birləşdirilir. |
Status kodları
- 200 Kod yeniləndi.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Kod yoxdur və ya sizə aid deyil.
- 422 Etibarsız sahə; məsələn, statik kodun hədəfi dəyişdirilə bilməz.
curl -X PATCH https://api.oqur.io/v1/qr-codes/qr_7Kq2mX \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "target": { "url": "https://kafeadi.com/kis-menusu" } }'
<?php
$res = $oqur->patch('qr-codes/qr_7Kq2mX', [
'json' => ['target' => ['url' => 'https://kafeadi.com/kis-menusu']],
]);
const { data } = await oqur('/qr-codes/qr_7Kq2mX', {
method: 'PATCH',
body: JSON.stringify({ target: { url: 'https://kafeadi.com/kis-menusu' } }),
});
Cavab 200 NÜMUNƏ
{
"data": {
"id": "qr_7Kq2mX",
"status": "active",
"short_url": "https://oqur.io/d/7Kq2xP",
"target": { "url": "https://kafeadi.com/kis-menusu" },
"updated_at": "2026-09-30T10:15:03Z"
}
}
Çoxalt
POST
/qr-codes/{id}/duplicate
Kodu dizaynı və hədəfi ilə birlikdə kopyalayır. Surət yeni qısa keçid və sıfır skanla başlayır; filiallar üçün eyni dizaynı çoxaltmağın ən sürətli yolu.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:write
Yol parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idməcburi |
string |
Kopyalanacaq kodun identifikatoru. |
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
name |
string |
Surətin adı. Boş buraxsanız, əsl adın sonuna «(surət)» əlavə olunur. |
folder_id |
string |
Surətin əlavə olunacağı qovluq. Defolt: əsl kodun qovluğu. |
Status kodları
- 201 Surət yaradıldı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 403 Dinamik kod limitinə çatdınız.
- 404 Kod yoxdur və ya sizə aid deyil.
curl -X POST https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/duplicate \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Afişa · Beşiktaş" }'
<?php
$res = $oqur->post('qr-codes/qr_7Kq2mX/duplicate', [
'json' => ['name' => 'Afişa · Beşiktaş'],
]);
const { data: copy } = await oqur('/qr-codes/qr_7Kq2mX/duplicate', {
method: 'POST',
body: JSON.stringify({ name: 'Afişa · Beşiktaş' }),
});
Cavab 201 NÜMUNƏ
{
"data": {
"id": "qr_9Ms4pZ",
"type": "url",
"name": "Afişa · Beşiktaş",
"status": "active",
"short_url": "https://oqur.io/d/9Ms4pR",
"scans_total": 0,
"created_at": "2026-09-30T10:20:31Z"
}
}
Şəkil yarat
POST
/qr-codes/{id}/image
Kodun çapa hazır şəklini yaradır və qısamüddətli endirmə keçidi qaytarır. Saxlanılmış dizaynı dəyişmədən bu şəkil üçün xüsusi tənzimləmə ötürə bilərsiniz.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:read
Yol parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idməcburi |
string |
Kodun identifikatoru. |
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
formatməcburi |
string |
png, svg, pdf və ya eps. |
size |
integer |
PNG üçün tərəfin uzunluğu, piksel. 256 ilə 4096 arası; defolt 1024. |
margin |
integer |
Sakit zona, modul sayı. Defolt 4; daha azı tövsiyə olunmur. |
design |
object |
Yalnız bu şəkil üçün müvəqqəti dizayn tənzimləmələri. |
Endirmə keçidi 1 saat etibarlıdır. Faylı öz serverinizdə saxlamaq istəyirsinizsə, «Şəkli al» endpoint-indən istifadə edin.
Status kodları
- 200 Şəkil hazırdır.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Kod yoxdur və ya sizə aid deyil.
- 422 Dəstəklənməyən format və ya ölçü.
curl -X POST https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "format": "svg", "margin": 4 }'
<?php
$res = $oqur->post('qr-codes/qr_7Kq2mX/image', [
'json' => ['format' => 'svg', 'margin' => 4],
]);
$url = json_decode($res->getBody(), true)['data']['url'];
const { data } = await oqur('/qr-codes/qr_7Kq2mX/image', {
method: 'POST',
body: JSON.stringify({ format: 'svg', margin: 4 }),
});
console.log(data.url); // 1 saat etibarlıdır
Cavab 200 NÜMUNƏ
{
"data": {
"format": "svg",
"url": "https://cdn.oqur.io/r/qr_7Kq2mX.svg?sig=Vb8f2…",
"expires_at": "2026-09-30T11:12:44Z"
}
}
Şəkli al
GET
/qr-codes/{id}/image.{format}
Şəkli birbaşa fayl kimi qaytarır. Cavab JSON deyil, faylın özüdür; serverinizdə saxlamaq və ya çap axınına əlavə etmək üçün uyğundur.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:read
Yol parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idməcburi |
string |
Kodun identifikatoru. |
formatməcburi |
string |
png, svg, pdf və ya eps. |
Sorğu parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
size |
integer |
PNG üçün tərəfin uzunluğu, piksel. Defolt 1024. |
margin |
integer |
Sakit zona, modul sayı. Defolt 4. |
Status kodları
- 200 Fayl qayıtdı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Kod yoxdur və ya sizə aid deyil.
- 422 Dəstəklənməyən format və ya ölçü.
curl https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image.png?size=2048 \
-H "Authorization: Bearer $OQUR_API_KEY" \
-o masa-karti.png
<?php
$oqur->get('qr-codes/qr_7Kq2mX/image.png', [
'query' => ['size' => 2048],
'sink' => __DIR__ . '/masa-karti.png',
]);
import { writeFile } from 'node:fs/promises';
const res = await fetch('https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image.png?size=2048', {
headers: { Authorization: `Bearer ${process.env.OQUR_API_KEY}` },
});
await writeFile('masa-karti.png', Buffer.from(await res.arrayBuffer()));
Cavab 200 NÜMUNƏ
HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: 48213
Content-Disposition: attachment; filename="qr_7Kq2mX.png"
Cache-Control: private, max-age=300
(ikili PNG verisi)
Kütləvi sil
DELETE
/qr-codes?ids=…
Ən çox 100 kodu səbətə köçürür. Səbətdəki kodlar 30 gün ərzində paneldən geri qaytarıla bilər; səbətdəki dinamik kodu skan edənlər «bu kod istifadə olunmur» səhifəsi görür. Kodu yalnız dayandırmaq istəyirsinizsə, status sahəsini paused edin.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:write
Sorğu parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
idsməcburi |
string |
Vergüllə ayrılmış kod identifikatorları, ən çox 100. |
Status kodları
- 200 Kodlar səbətə köçürüldü.
- 401 API açarı yoxdur və ya etibarsızdır.
- 404 Siyahıdakı kod tapılmadı; heç bir kod silinmədi.
- 422 İdentifikator siyahısı boşdur və ya 100-ü keçir.
curl -X DELETE "https://api.oqur.io/v1/qr-codes?ids=qr_7Kq2mX,qr_8Lr3nY,qr_9Ms4pZ" \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->delete('qr-codes', ['query' => [
'ids' => implode(',', ['qr_7Kq2mX', 'qr_8Lr3nY', 'qr_9Ms4pZ']),
]]);
const ids = ['qr_7Kq2mX', 'qr_8Lr3nY', 'qr_9Ms4pZ'].join(',');
const { meta } = await oqur(`/qr-codes?ids=${ids}`, { method: 'DELETE' });
Cavab 200 NÜMUNƏ
{
"meta": { "deleted": 3 }
}
Analitika
Skan məlumatlarını öz hesabatlarınıza çəkin. Hesabatda şəxsi məlumat yoxdur: IP ünvanı, cihaz identifikatoru və ya dəqiq yer qaytarılmır.
Analitika hesabatı
GET
/analytics/scans
Seçdiyiniz kodlar və tarix aralığı üçün cəmləri, zaman sırasını və bölgünü qaytarır. Tarix və saatlar istədiyiniz saat qurşağında qruplaşdırılır.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: analytics:read
Sorğu parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
fromməcburi |
date |
Başlanğıc tarixi, YYYY-MM-DD. |
toməcburi |
date |
Bitmə tarixi, daxil olmaqla. Aralıq ən çox 366 gün. |
qr_ids |
string |
Vergüllə ayrılmış kod identifikatorları. Boş buraxsanız, bütün kodlar. |
timezone |
string |
IANA saat qurşağı, məsələn Asia/Baku. Defolt: iş sahəsinin saat qurşağı. |
group_by |
string |
hour, day, week və ya month. Defolt day. |
breakdown |
string |
country, city, device, os və ya browser. |
Status kodları
- 200 Hesabat qayıtdı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 422 Tarix aralığı etibarsızdır və ya 366 günü keçir.
- 429 Sürət limitinə çatdınız.
curl -G https://api.oqur.io/v1/analytics/scans \
-H "Authorization: Bearer $OQUR_API_KEY" \
-d from=2026-09-01 \
-d to=2026-09-07 \
-d timezone=Europe/Istanbul \
-d group_by=day \
-d breakdown=device
<?php
$res = $oqur->get('analytics/scans', ['query' => [
'from' => '2026-09-01',
'to' => '2026-09-07',
'timezone' => 'Europe/Istanbul',
'group_by' => 'day',
'breakdown' => 'device',
]]);
const params = new URLSearchParams({
from: '2026-09-01',
to: '2026-09-07',
timezone: 'Europe/Istanbul',
group_by: 'day',
breakdown: 'device',
});
const { data: report } = await oqur(`/analytics/scans?${params}`);
Cavab 200 NÜMUNƏ
{
"data": {
"range": { "from": "2026-09-01", "to": "2026-09-07", "timezone": "Europe/Istanbul" },
"totals": { "scans": 1840, "unique_scans": 1312 },
"series": [
{ "period": "2026-09-01", "scans": 212, "unique_scans": 160 },
{ "period": "2026-09-02", "scans": 247, "unique_scans": 181 }
],
"breakdown": {
"by": "device",
"items": [
{ "key": "ios", "scans": 1011 },
{ "key": "android", "scans": 783 },
{ "key": "desktop", "scans": 46 }
]
}
}
}
Qovluqlar
Kodlarınızı filial, kampaniya və ya müştəri üzrə qruplaşdırın. Komandadakı hər kəs bütün qovluqları görür; kimin nə edə biləcəyini rolu müəyyən edir.
Qovluq yarat
POST
/folders
Kodlarınızı qruplaşdırmaq üçün yeni qovluq yaradır.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: folders:write
Sorğu gövdəsi
| Sahə | Növ | Təsvir |
|---|---|---|
nameməcburi |
string |
Qovluq adı, 1 ilə 80 simvol arası. Hesabınızda unikal olmalıdır. |
Status kodları
- 201 Qovluq yaradıldı.
- 401 API açarı yoxdur və ya etibarsızdır.
- 409 Bu adda qovluq artıq var.
- 422 Ad boşdur və ya 80 simvolu keçir.
curl -X POST https://api.oqur.io/v1/folders \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Kadıköy filialı" }'
<?php
$res = $oqur->post('folders', ['json' => ['name' => 'Kadıköy filialı']]);
const { data: folder } = await oqur('/folders', {
method: 'POST',
body: JSON.stringify({ name: 'Kadıköy filialı' }),
});
Cavab 201 NÜMUNƏ
{
"data": {
"id": "fld_91xQ",
"name": "Kadıköy filialı",
"qr_count": 0,
"created_at": "2026-09-30T10:31:08Z"
}
}
Qovluqların siyahısı
GET
/folders
Hesabınızdakı qovluqları içlərindəki kod sayı ilə birlikdə qaytarır.
Autentifikasiya: ApiKeyAuth (Bearer)İcazə: qr:read
Sorğu parametrləri
| Sahə | Növ | Təsvir |
|---|---|---|
page |
integer |
Səhifə nömrəsi. Defolt 1. |
per_page |
integer |
Səhifədə qeyd. Defolt 25, ən çox 100. |
Status kodları
- 200 Siyahı qayıtdı.
- 401 API açarı yoxdur və ya etibarsızdır.
curl https://api.oqur.io/v1/folders \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->get('folders');
$folders = json_decode($res->getBody(), true)['data'];
const { data: folders } = await oqur('/folders');
Cavab 200 NÜMUNƏ
{
"data": [
{ "id": "fld_91xQ", "name": "Kadıköy filialı", "qr_count": 14 },
{ "id": "fld_22bR", "name": "Qablaşdırma · Sentyabr", "qr_count": 120 }
],
"meta": { "page": 1, "per_page": 25, "total": 2 }
}
Xəta kodları
Xətalar həmişə eyni formada qayıdır: HTTP status kodu və error obyekti. code sahəsi proqramınız, message sahəsi insanlar üçündür; mesaj mətni dəyişə bilər, koda etibar edin.
Statuslar
| HTTP | code | Təsvir |
|---|---|---|
400 |
bad_request |
Sorğu gövdəsi oxunmadı. JSON-un etibarlı olduğuna əmin olun və Content-Type başlığını yoxlayın. |
401 |
unauthenticated |
API açarı yoxdur və ya etibarsızdır. Authorization başlığını yoxlayın. |
403 |
forbidden |
Planınızın və ya açarınızın icazəsi bu əməliyyata çatmır; məsələn, dinamik kod limitinə çatmısınız. |
404 |
not_found |
Qeyd yoxdur və ya sizin hesabınıza aid deyil. |
409 |
conflict |
Eyni adda qeyd var və ya Idempotency-Key fərqli gövdə ilə təkrar istifadə olunub. |
422 |
validation_failed |
Sahə etibarsızdır. Hansı sahənin niyə rədd edildiyi details massivindədir. |
429 |
rate_limited |
Sürət limitinə çatdınız. Retry-After qədər gözləyin. |
500 |
server_error |
Bizim tərəfdə problem var. Yenidən cəhd edin; davam edərsə, request_id ilə bizə yazın. |
Cavab 422 NÜMUNƏ
{
"error": {
"code": "validation_failed",
"message": "2 element yoxlamadan keçmədi.",
"details": [
{ "field": "items.0.target.url", "message": "Etibarlı veb-ünvan olmalıdır." },
{ "field": "items.3.type", "message": "Bilinmeyen QR tipi: menu2." }
],
"request_id": "req_3hV8qL"
}
}
Əvvəlcə paneldə sınayın, sonra avtomatlaşdırın.
API hazır olanda Biznes və Korporativ planlarda açılacaq. Korporativ inteqrasiyalar üçün satış komandamızla danışa bilərsiniz.