תיעוד API
ביולינקים
בדוק ונהל את דפי הביולינק שלך מה-API הציבורי.
אימות
כל בקשה חייבת לשלוח את כותרת Authorization עם אסימון Bearer שתואם למפתח ה-API של המנהל.
קבל מפתח API.
נקודת קצה
GET https://rqrcode.com/api/biolinks/
דוגמה
curl --request GET \
--url 'https://rqrcode.com/api/biolinks/' \
--header 'Authorization: Bearer {api_key}'
פרמטרים
| פרמטרים | פרטים | תיאור |
|---|---|---|
| page |
אופציונלי
ui.admin.api_docs.common.types.מספר שלם
|
מספר העמוד שברצונך לקבל את התוצאות עבורו. ברירת המחדל היא 1. |
| results_per_page |
אופציונלי
ui.admin.api_docs.common.types.מספר שלם
|
כמה תוצאות אתה רוצה לכל עמוד. הערכים המותרים הם: 10, 25, 50, 100, 250, 500, 1000. ברירת המחדל היא 25. |
דוגמת תגובה
{
"data": [
{
"id": 1,
"project_id": null,
"name": "ביוגרפיה ראשית",
"url": "יוצר",
"pageviews": 120,
"datetime": "2026-04-20 07:55:35"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/biolinks?page=1",
"last": "https://rqrcode.com/api/biolinks?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/biolinks?page=1"
}
}
נקודת קצה
GET https://rqrcode.com/api/biolinks/{biolink_id}
דוגמה
curl --request GET \
--url 'https://rqrcode.com/api/biolinks/{biolink_id}' \
--header 'Authorization: Bearer {api_key}'
פרמטרים
אין פרמטר נוסף.
דוגמת תגובה
{
"data": {
"id": 1,
"project_id": null,
"name": "ביוגרפיה ראשית",
"url": "יוצר",
"pageviews": 120,
"datetime": "2026-04-20 07:55:35"
}
}
נקודת קצה
POST https://rqrcode.com/api/biolinks
דוגמה
curl --request POST \
--url 'https://rqrcode.com/api/biolinks' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=דף יוצר' \
--form 'url=יוצר'
פרמטרים
| פרמטרים | פרטים | תיאור |
|---|---|---|
| name |
נדרש
ui.admin.api_docs.common.types.מחרוזת
|
— |
| url |
אופציונלי
ui.admin.api_docs.common.types.מחרוזת
|
כינוי ביולינק. |
| project_id |
אופציונלי
ui.admin.api_docs.common.types.מספר שלם
|
— |
דוגמת תגובה
{
"data": {
"id": 1
}
}
נקודת קצה
POST https://rqrcode.com/api/biolinks/{biolink_id}
דוגמה
curl --request POST \
--url 'https://rqrcode.com/api/biolinks/{biolink_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=דף יוצר גרסה 2'
פרמטרים
| פרמטרים | פרטים | תיאור |
|---|---|---|
| name |
אופציונלי
ui.admin.api_docs.common.types.מחרוזת
|
— |
| url |
אופציונלי
ui.admin.api_docs.common.types.מחרוזת
|
כינוי ביולינק. |
| project_id |
אופציונלי
ui.admin.api_docs.common.types.מספר שלם
|
— |
דוגמת תגובה
{
"data": {
"id": 1
}
}
נקודת קצה
DELETE https://rqrcode.com/api/biolinks/{biolink_id}
דוגמה
curl --request DELETE \
--url 'https://rqrcode.com/api/biolinks/{biolink_id}' \
--header 'Authorization: Bearer {api_key}'
פרמטרים
אין פרמטר נוסף.
דוגמת תגובה
גוף תגובת 200 ריק בעת הצלחה.