Entwickler

API-Referenz für Entwickler

Für die Verarbeitung von Anfragen durch das System ist ein API-Schlüssel erforderlich. Nach der Registrierung wird für jeden Benutzer automatisch ein API-Schlüssel erstellt.

Einstieg

Damit Anfragen vom System verarbeitet werden können, ist ein API-Schlüssel erforderlich. Sobald sich ein Benutzer registriert, wird automatisch ein API-Schlüssel für diesen Benutzer generiert. Der API-Schlüssel muss mit jeder Anfrage gesendet werden (siehe vollständiges Beispiel unten). Wenn der API-Schlüssel nicht gesendet wird oder abgelaufen ist, wird ein Fehler angezeigt. Bitte achten Sie darauf, Ihren API-Schlüssel geheim zu halten, um Missbrauch zu verhindern.

Authentifizierung

Um sich beim API-System zu authentifizieren, müssen Sie bei jeder Anfrage Ihren API-Schlüssel als Autorisierungstoken senden. Unten sehen Sie einen Beispielcode.

curl --location --request POST 'https://go2my.info/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \ 

Rate Limit

Unsere API verfügt über einen Ratenbegrenzer zum Schutz vor Anfragenspitzen, um ihre Stabilität zu maximieren. Unser Ratenbegrenzer ist derzeit auf 30 Anfragen pro 1 Minute begrenzt. Bitte beachten Sie, dass sich der Preis je nach abonniertem Tarif ändern kann.

Neben der Antwort werden mehrere Header gesendet, die untersucht werden können, um verschiedene Informationen über die Anfrage zu ermitteln.

X-RateLimit-Limit: 30X-RateLimit-Remaining: 29X-RateLimit-Reset: TIMESTAMP

Antwortbehandlung

Alle API-Antworten werden standardmäßig im JSON-Format zurückgegeben. Um diese in verwertbare Daten umzuwandeln, muss je nach Sprache die entsprechende Funktion verwendet werden. In PHP kann die Funktion json_decode() verwendet werden, um die Daten entweder in ein Objekt (Standard) oder ein Array (zweiten Parameter auf true setzen) zu konvertieren. Es ist sehr wichtig, den Fehlerschlüssel zu überprüfen, da er Auskunft darüber gibt, ob ein Fehler aufgetreten ist oder nicht. Sie können auch den Header-Code überprüfen.

{
    "error": 1,
    "message": "An error occurred"
}

Call-to-Action Overlays

CTA-Overlays auflisten

GET https://go2my.info/api/overlay?limit=2&page=1

Um CTA-Overlays über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "message",
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Contact Page",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Dateien

Dateien auflisten

GET https://go2my.info/api/files?limit=2&page=1

Ruft alle Ihre Dateien ab. Sie können auch nach Namen suchen.

Parameter Beschreibung
name (optional) Datei nach Namen suchen
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/go2my.info\/jWaPl",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/go2my.info\/dLpqa",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/go2my.info\/eCLKG",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Datei hochladen

POST https://go2my.info/api/files/upload/:filename?name=My+File

Laden Sie eine Datei hoch, indem Sie die Binärdaten als POST-Body senden. Geben Sie in der URL anstelle von :filename den Dateinamen inklusive Endung an (z. B. brandkit.zip). Optionen können Sie über die folgenden Parameter festlegen.

Parameter Beschreibung
name (optional) Dateiname
custom (optional) Benutzerdefinierter Alias anstelle eines zufälligen Alias.
domain (optional) Eigene Domain
password (Optional) Passwortschutz
expiry (optional) Ablaufdatum des Downloads, z. B. 2021-09-28
maxdownloads (optional) Maximale Anzahl an Downloads
curl --location --request POST 'https://go2my.info/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'

Antwort des Servers

{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/go2my.info\/ridAf"
}

Eigene Domains

Markendomains auflisten

GET https://go2my.info/api/domains?limit=2&page=1

Um Ihre Markendomains über die API zu erhalten, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}

Markendomain erstellen

POST https://go2my.info/api/domain/add

Mit diesem Endpunkt kann eine Domain hinzugefügt werden. Bitte stellen Sie sicher, dass die Domain korrekt auf unseren Server zeigt.

Parameter Beschreibung
domain (erforderlich) Markendomain einschließlich http oder https
redirectroot (optional) Root-Weiterleitung, wenn jemand Ihre Domain besucht
redirect404 (optional) Benutzerdefinierte 404-Weiterleitung
curl --location --request POST 'https://go2my.info/api/domain/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'

Antwort des Servers

{
    "error": 0,
    "id": 1
}

Domain aktualisieren

PUT https://go2my.info/api/domain/:id/update

Um eine Markendomain zu aktualisieren, müssen Sie gültige JSON-Daten per PUT-Anfrage senden. Die Daten müssen wie unten gezeigt als Raw-Body Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können; Sie müssen jedoch nicht alle senden (weitere Informationen siehe Tabelle).

Parameter Beschreibung
redirectroot (optional) Root-Weiterleitung, wenn jemand Ihre Domain besucht
redirect404 (optional) Benutzerdefinierte 404-Weiterleitung
curl --location --request PUT 'https://go2my.info/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

Antwort des Servers

{
    "error": 0,
    "message": "Domain has been updated successfully."
}

Domain löschen

DELETE https://go2my.info/api/domain/:id/delete

Um eine Domain zu löschen, müssen Sie eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://go2my.info/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

Eigene Splash-Seite

Benutzerdefinierte Splash-Seiten auflisten

GET https://go2my.info/api/splash?limit=2&page=1

Über diesen Endpunkt rufen Sie Splash-Seiten per API ab. Sie können die Daten auch filtern (weitere Informationen in der Tabelle).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Kampagnen

Kampagnen auflisten

GET https://go2my.info/api/campaigns?limit=2&page=1

Um Ihre Kampagnen über die API zu erhalten, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "campaigns": [
            {
                "id": 1,
                "name": "Sample Campaign",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook Campaign",
                "public": true,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}

Kampagne erstellen

POST https://go2my.info/api/campaign/add

Eine Kampagne kann mit diesem Endpunkt hinzugefügt werden.

Parameter Beschreibung
name (optional) Kampagnenname
slug (optional) Rotator-Slug
public (Optional) Zugriff
curl --location --request POST 'https://go2my.info/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

Antwort des Servers

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
POST https://go2my.info/api/campaign/:campaignid/assign/:linkid

Mit diesem Endpunkt kann ein Kurzlink einer Kampagne zugewiesen werden. Der Endpunkt benötigt die Kampagnen-ID und die Kurzlink-ID.

curl --location --request POST 'https://go2my.info/api/campaign/:campaignid/assign/:linkid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Link successfully added to the campaign."
}

Kampagne aktualisieren

PUT https://go2my.info/api/campaign/:id/update

Um eine Kampagne zu aktualisieren, müssen Sie gültige JSON-Daten per PUT-Anfrage senden. Die Daten müssen wie unten gezeigt als Raw-Body Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können; Sie müssen jedoch nicht alle senden (weitere Informationen siehe Tabelle).

Parameter Beschreibung
name (Erforderlich) Kampagnenname
slug (optional) Rotator-Slug
public (Optional) Zugriff
curl --location --request PUT 'https://go2my.info/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

Antwort des Servers

{
    "error": 0,
    "id": 3,
    "domain": "Twitter Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}

Kampagne löschen

DELETE https://go2my.info/api/campaign/:id/delete

Um eine Kampagne zu löschen, müssen Sie eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://go2my.info/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}

Kanäle

Kanäle auflisten

GET https://go2my.info/api/channels?limit=2&page=1

Um Ihre Kanäle über die API zu erhalten, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "name": "Channel 1",
                "description": "Description of channel 1",
                "color": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "name": "Channel 2",
                "description": "Description of channel 2",
                "color": "#FF0000",
                "starred": false
            }
        ]
    }
}

Kanalelemente auflisten

GET https://go2my.info/api/channel/:id?limit=1&page=1

Um die Elemente eines ausgewählten Kanals über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "links",
                "id": 1,
                "title": "My Sample Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/go2my.info\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/go2my.info\/mybio",
                "link": "https:\/\/go2my.info\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

Kanal erstellen

POST https://go2my.info/api/channel/add

Ein Kanal kann mit diesem Endpunkt hinzugefügt werden.

Parameter Beschreibung
name (Erforderlich) Kanalname
description (Optional) Kanalbeschreibung
color (optional) Badge-Farbe des Kanals (HEX)
starred (optional) Kanal markieren oder nicht (true oder false)
curl --location --request POST 'https://go2my.info/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'

Antwort des Servers

{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}

Element einem Kanal zuweisen

POST https://go2my.info/api/channel/:channelid/assign/:type/:itemid

Ein Element kann jedem Kanal zugewiesen werden, indem eine Anfrage mit der Kanal-ID, dem Elementtyp (links, bio oder qr) und der Element-ID gesendet wird.

Parameter Beschreibung
:channelid (erforderlich) Kanal-ID
:type (erforderlich) links, bio oder qr
:itemid (erforderlich) Element-ID
curl --location --request POST 'https://go2my.info/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

Kanal aktualisieren

PUT https://go2my.info/api/channel/:id/update

Um einen Kanal zu aktualisieren, müssen Sie gültige JSON-Daten per PUT-Anfrage senden. Die Daten müssen wie unten gezeigt als Raw-Body Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können; Sie müssen jedoch nicht alle senden (weitere Informationen siehe Tabelle).

Parameter Beschreibung
name (Optional) Kanalname
description (Optional) Kanalbeschreibung
color (optional) Badge-Farbe des Kanals (HEX)
starred (optional) Kanal markieren oder nicht (true oder false)
curl --location --request PUT 'https://go2my.info/api/channel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}'

Antwort des Servers

{
    "error": 0,
    "message": "Channel has been updated successfully."
}

Kanal löschen

DELETE https://go2my.info/api/channel/:id/delete

Um einen Kanal zu löschen, müssen Sie eine DELETE-Anfrage senden. Alle Elemente werden dabei ebenfalls aus dem Kanal entfernt.

curl --location --request DELETE 'https://go2my.info/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

Konto abrufen

GET https://go2my.info/api/account

Um Informationen über das Konto zu erhalten, können Sie eine Anfrage an diesen Endpunkt senden, der Daten über das Konto zurückgibt.

curl --location --request GET 'https://go2my.info/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "data": {
        "id": 1,
        "email": "sample@domain.com",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registered": "2020-11-10 18:01:43"
    }
}

Konto aktualisieren

PUT https://go2my.info/api/account/update

Um Informationen zu dem Konto zu aktualisieren, können Sie eine Anfrage an diesen Endpunkt senden und er aktualisiert die Daten zu dem Konto.

curl --location --request PUT 'https://go2my.info/api/account/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "newemail@google.com",
    "password": "NewPassword1"
}'

Antwort des Servers

{
    "error": 0,
    "message": "Account has been successfully updated."
}

Pixel auflisten

GET https://go2my.info/api/pixels?limit=2&page=1

Um Ihre Pixelcodes über die API zu erhalten, können Sie diesen Endpunkt verwenden. Sie können auch Daten filtern (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "pixels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Pixel erstellen

POST https://go2my.info/api/pixel/add

Ein Pixel kann mit diesem Endpunkt erstellt werden. Sie müssen den Pixeltyp und das Tag senden.

Parameter Beschreibung
type (required) gtmpixel | gapixel | fbpixel | adwordspixel | linkedinpixel | twitterpixel | adrollpixel | quorapixel | pinterest | bing | snapchat | reddit | tiktok
name (erforderlich) Benutzerdefinierter Name für Ihr Pixel
tag (Erforderlich) Das Tag für das Pixel
curl --location --request POST 'https://go2my.info/api/pixel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

Antwort des Servers

{
    "error": 0,
    "id": 1
}

Pixel aktualisieren

PUT https://go2my.info/api/pixel/:id/update

Um ein Pixel zu aktualisieren, müssen Sie gültige JSON-Daten per PUT-Anfrage senden. Die Daten müssen wie unten gezeigt als Raw-Body Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können; Sie müssen jedoch nicht alle senden (weitere Informationen siehe Tabelle).

Parameter Beschreibung
name (optional) Benutzerdefinierter Name für Ihr Pixel
tag (Erforderlich) Das Tag für das Pixel
curl --location --request PUT 'https://go2my.info/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

Antwort des Servers

{
    "error": 0,
    "message": "Pixel has been updated successfully."
}

Pixel löschen

DELETE https://go2my.info/api/pixel/:id/delete

Um ein Pixel zu löschen, müssen Sie eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://go2my.info/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}

QR-Codes

QR-Codes auflisten

GET https://go2my.info/api/qr?limit=2&page=1

Um Ihre QR-Codes über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können Daten auch filtern (weitere Informationen finden Sie in der Tabelle).

Parameter Beschreibung
limit (optional) Ergebnisse pro Seite
page (optional) Aktuelle Seite
curl --location --request GET 'https://go2my.info/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/go2my.info\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/go2my.info\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

Einzelnen QR-Code abrufen

GET https://go2my.info/api/qr/:id

Um Details für einen einzelnen QR-Code über die API abzurufen, können Sie diesen Endpunkt verwenden.

curl --location --request GET 'https://go2my.info/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/go2my.info\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "clicks": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Unknown": "1"
        },
        "topReferrers": {
            "Direct, email and other": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "instagram": 0
        }
    }
}

QR-Code erstellen

POST https://go2my.info/api/qr/add

Um einen QR-Code zu erstellen, müssen Sie gültige JSON-Daten per POST-Anfrage senden. Die Daten müssen wie unten gezeigt als Raw-Body Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können; Sie müssen jedoch nicht alle senden (weitere Informationen siehe Tabelle).

Parameter Beschreibung
type (erforderlich) text | vcard | link | email | phone | sms | wifi
data (erforderlich) Daten, die in den QR-Code eingebettet werden sollen. Die Daten können je nach Typ ein String oder ein Array sein
background (optional) RGB-Farbe, z. B. rgb(255,255,255)
foreground (optional) RGB-Farbe, z. B. rgb(0,0,0)
logo (optional) Pfad zum Logo, entweder PNG oder JPG
name (optional) QR-Code-Name
curl --location --request POST 'https://go2my.info/api/qr/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}'

Antwort des Servers

{
    "error": 0,
    "id": 3,
    "link": "https:\/\/go2my.info\/qr\/a58f79"
}

QR-Code aktualisieren

PUT https://go2my.info/api/qr/:id/update

Um einen QR-Code zu aktualisieren, müssen Sie gültige Daten in JSON über eine PUT-Anforderung senden. Die Daten müssen wie unten gezeigt als Rohtext Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können, aber Sie müssen nicht alle senden (siehe Tabelle für weitere Informationen).

Parameter Beschreibung
data (erforderlich) Daten, die in den QR-Code eingebettet werden sollen. Die Daten können je nach Typ ein String oder ein Array sein
background (optional) RGB-Farbe, z. B. rgb(255,255,255)
foreground (optional) RGB-Farbe, z. B. rgb(0,0,0)
logo (optional) Pfad zum Logo, entweder PNG oder JPG
curl --location --request PUT 'https://go2my.info/api/qr/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

Antwort des Servers

{
    "error": 0,
    "message": "QR has been updated successfully."
}

QR-Code löschen

DELETE https://go2my.info/api/qr/:id/delete

Um einen QR-Code zu löschen, müssen Sie eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://go2my.info/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwort des Servers

{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}