On this page

    1. Home
    2. API
    3. API Reference
    4. Device
    5. Device Adopt Code QR

    Device Adopt Code QR

    This endpoint generates a QR code image representing a device adoption code. This allows for easy scanning by mobile devices or other hardware to initiate the adoption process between networks.


    GET /device/adopt-code/{code}/qr.png

    Returns a PNG image of the QR code for the specified adoption code.

    Request

    GET /device/adopt-code/{code}/qr.png

    Parameters:

    NameInTypeRequiredDescription
    codepathstringYesThe alphanumeric adoption code generated via /device/create-adopt-code.

    Headers:

    {
      "Host": "api.bringyour.com",
      "Accept": "image/png"
    }

    Response

    200 Success

    Status: 200 OK

    Content-Type: image/png

    The response body contains the binary data of the PNG image.

    Example

    HTTP Request

    GET /device/adopt-code/ADOPT-XYZ-123/qr.png HTTP/1.1
    Host: api.bringyour.com
    Accept: image/png

    Successful HTTP Response

    HTTP/1.1 200 OK
    Content-Type: image/png
    [Binary Image Data]


    Powered by Sudoc v2.5.0
    Hide table of contents