டைனமிக் QR குறியீட்டு API ஆவணங்கள் | QR Cake

    QR Cake API மூலம் டைனமிக் QR குறியீடுகளை உருவாக்கவும், புதுப்பிக்கவும், நிர்வகிக்கவும். API விசைகளுடன் கோரிக்கைகளைச் சோதித்து QR பணிகளை உங்கள் கருவிகளுடன் இணைக்கவும்.

    JSON REST APIடைனமிக் QR உருவாக்கம்API விசை அங்கீகாரம்

    விரைவு தொடக்கம்

    QR Cake API மூலம் QR Cake பயனர்கள் தங்கள் கணக்கிலுள்ள QR குறியீடுகளை நிர்வகிக்க முடியும்.

    அடிப்படை URL
    https://api.qrcake.com/v1/product/api

    அங்கீகாரம்

    உங்கள் டாஷ்போர்டில் ஒரு API விசையை உருவாக்கி, அதை x-api-key ஹெடரில் அனுப்பவும்.

    x-api-key: <API Key>
    Content-Type: application/json

    API விசைகளை நிர்வகிக்க டாஷ்போர்டில் உள்ள API விசைகள்.

    API கோரிக்கை சோதனையாளர்

    இந்தப் பக்கத்திலிருந்தே எண்ட்பாயிண்ட்களைச் சோதிக்கலாம். உங்கள் API விசையை உள்ளிட்டு, எண்ட்பாயிண்டைத் தேர்ந்தெடுத்து, பதிலை உடனே பாருங்கள்.

    ஊடாடும் API சோதனையாளர்

    தேர்ந்தெடுத்துள்ள QR Cake API எண்ட்பாயிண்டுக்கு உங்கள் உலாவியிலிருந்தே நேரடியாக கோரிக்கைகளை அனுப்புங்கள்.

    GET
    x-api-key: YOUR_API_KEY
    தீர்மானிக்கப்பட்ட URL
    https://api.qrcake.com/v1/product/api/product
    நிலை மற்றும் பதிலை இங்கே பார்க்க ஒரு கோரிக்கையை இயக்கவும்.

    சொற்களஞ்சியம்

    தயாரிப்புகள்

    QR குறியீடுகள்

    பயனர்கள்

    QR Cake கணக்குகள்

    கோரிக்கை உட்பொருள்கள் (POST/PUT)

    POST மற்றும் PUT கோரிக்கைகளில், request body ஒரு string ஆக மாற்றப்பட வேண்டும். JSON அனுப்பினால், அதை JSON string ஆகவே அனுப்புங்கள் (எடுத்துக்காட்டு JSON.stringify(payload)).

    const payload = { redirect: "https://example.com", metadata: {} };
    
    await fetch(url, {
      method: "POST",
      body: JSON.stringify(payload),
    });
    GET

    QR குறியீடுகளின் பட்டியல்

    API விசைக்கு அணுகக்கூடிய QR குறியீடுகளின் பட்டியலை வழங்குகிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /product
    URL: https://api.qrcake.com/v1/product/api/product
    கோரிக்கை விவரங்கள்
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Accept: application/json
    பதில்கள்
    200 OK
    [
      {
        "accountId": "string",
        "productId": "string",
        "userId": "string",
        "redirect": "string",
        "state": "ACTIVE",
        "metadata": {},
        "createdAt": 0,
        "updatedAt": 0
      }
    ]
    401 Unauthorized
    {
      "message": {}
    }

    இங்கே "Products" என்பது QR குறியீடுகளைக் குறிக்கிறது.

    GET

    ஒரு QR குறியீட்டைப் பெறவும்

    ஒரு QR குறியீட்டை பெறுகிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    கோரிக்கை விவரங்கள்
    பாதை அளவுருக்கள்
    • productId (string)
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Accept: application/json
    பதில்கள்
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }
    POST

    ஒரு QR குறியீட்டை உருவாக்கவும்

    புதிய QR குறியீட்டை உருவாக்குகிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /product
    URL: https://api.qrcake.com/v1/product/api/product
    கோரிக்கை விவரங்கள்
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Content-Type: application/json
    • Accept: application/json
    உட்பொருள் மாதிரி
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    பதில்கள்
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    POST request body ஒரு string ஆக மாற்றப்பட வேண்டும். எடுத்துக்காட்டு: JSON.stringify(payload).

    PUT

    ஒரு QR குறியீட்டை புதுப்பிக்கவும்

    ஏற்கனவே உள்ள QR குறியீட்டு தயாரிப்பை புதுப்பிக்கிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    கோரிக்கை விவரங்கள்
    பாதை அளவுருக்கள்
    • productId (string)
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Content-Type: application/json
    • Accept: application/json
    உட்பொருள் மாதிரி
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    பதில்கள்
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    PUT request body ஒரு string ஆக மாற்றப்பட வேண்டும்.

    DELETE

    ஒரு QR குறியீட்டை நீக்கவும்

    ஒரு QR குறியீட்டை நீக்குகிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    கோரிக்கை விவரங்கள்
    பாதை அளவுருக்கள்
    • productId (string)
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Accept: application/json
    பதில்கள்
    200 OK
    {
      "productId": "string"
    }
    401 Unauthorized
    {
      "message": {}
    }
    GET

    அனுமதிகள்

    API விசைக்கு வழங்கப்பட்ட அனுமதிகளைத் திருப்பி வழங்குகிறது.

    GitBook-ல் திறக்கவும்
    பாதை: /permission
    URL: https://api.qrcake.com/v1/product/api/permission
    கோரிக்கை விவரங்கள்
    ஹெடர்கள்
    • x-api-key: <API Key>
    • Accept: application/json
    பதில்கள்
    200 OK
    {
      "success": true,
      "result": {
        "tier": "subscriber",
        "active": true,
        "analytics": true,
        "productLimit": 100,
        "productTotal": 3,
        "productActiveLimit": 100,
        "productActiveTotal": 3
      }
    }
    401 Unauthorized
    {
      "message": {}
    }

    ஆதரிக்கப்படும் QR வகைகள்

    QR தயாரிப்புகளை உருவாக்கவும் புதுப்பிக்கவும் கீழே உள்ள metadata வகைகளைப் பயன்படுத்தலாம்.

    redirect, link, image, video, file, pdf, audio, app, event, vCard, review

    தொடங்குவதற்கு எங்கள் முகப்புப் பக்கத்தில் உள்ள டைனமிக் QR குறியீடுகள் மற்றும் மாற்றக்கூடிய QR குறியீடுகள் பற்றிய விளக்கங்களைப் பாருங்கள்.