Documentação da API de links - TELINKEI

Recuperar tudo

Endpoint

GET https://telinkei.com/api/links/

Exemplo

curl --request GET \
--url 'https://telinkei.com/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parâmetros	Detalhes	Descrição
page	Opcional Inteiro	O número da página da qual você deseja resultados. O padrão é `1`.
results_per_page	Opcional Inteiro	Quantos resultados você deseja por página. Os valores permitidos são: `10` , `25` , `50` , `100` , `250` , `500`. O padrão é `25`.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "example",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "clicks": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "date": "2020-11-15 12:00:00"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://telinkei.com/api/links?&page=1",
        "last": "https://telinkei.com/api/links?&page=1",
        "next": null,
        "prev": null,
        "self": "https://telinkei.com/api/links?&page=1"
    }
}

Recuperar um

Endpoint

GET https://telinkei.com/api/links/{link_id}

Exemplo

curl --request GET \
--url 'https://telinkei.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Exemplo de resposta

{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "example",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "clicks": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "date": "2020-11-15 12:00:00"
    }
}

Parâmetros	Detalhes	Descrição
type	Opcional String	`link`
location_url	Obrigatório String	A URL do destino.
url	Opcional String	O alias da URL do link gerado. Deixe em branco para um gerado aleatoriamente.
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
schedule	Opcional Booleano	-
start_date	Opcional String	(schedule=true)
end_date	Opcional String	(schedule=true)
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional String	-
sensitive_content	Opcional Booleano	-
passsword	Opcional String	-
targeting_type	Opcional String	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Opcional Inteiro	(targeting_type=country_code)
targeting_country_code_value[index]	Opcional String	(targeting_type=country_code)
targeting_device_type_key[index]	Opcional Inteiro	(targeting_type=device_type)
targeting_device_type_value[index]	Opcional String	(targeting_type=device_type)
targeting_browser_language_key[index]	Opcional Inteiro	(targeting_type=browser_language)
targeting_browser_language_value[index]	Opcional String	(targeting_type=browser_language)
targeting_rotation_key[index]	Opcional Inteiro	(targeting_type=rotation)
targeting_rotation_value[index]	Opcional String	(targeting_type=rotation)
targeting_os_name_key[index]	Opcional Inteiro	(targeting_type=os_name)
targeting_os_name_value[index]	Opcional String	(targeting_type=os_name)

curl --request POST \
--url 'https://telinkei.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://telinkei.com/' \

Exemplo de resposta

{
    "data": {
        "id": 1
    }
}

Atualizar

Endpoint

POST https://telinkei.com/api/links/{link_id}

Parâmetros	Detalhes	Descrição
location_url	Opcional String	A URL do destino.
url	Opcional String	O alias da URL do link gerado. Deixe em branco para um gerado aleatoriamente.
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
schedule	Opcional Booleano	-
start_date	Opcional String	(schedule=true)
end_date	Opcional String	(schedule=true)
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional String	-
sensitive_content	Opcional Booleano	-
passsword	Opcional String	-
targeting_type	Opcional String	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Opcional Inteiro	(targeting_type=country_code)
targeting_country_code_value[index]	Opcional String	(targeting_type=country_code)
targeting_device_type_key[index]	Opcional Inteiro	(targeting_type=device_type)
targeting_device_type_value[index]	Opcional String	(targeting_type=device_type)
targeting_browser_language_key[index]	Opcional Inteiro	(targeting_type=browser_language)
targeting_browser_language_value[index]	Opcional String	(targeting_type=browser_language)
targeting_rotation_key[index]	Opcional Inteiro	(targeting_type=rotation)
targeting_rotation_value[index]	Opcional String	(targeting_type=rotation)
targeting_os_name_key[index]	Opcional Inteiro	(targeting_type=os_name)
targeting_os_name_value[index]	Opcional String	(targeting_type=os_name)

Exemplo

curl --request POST \
--url 'https://telinkei.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Exemplo de resposta

{
  "data": {
    "id": 1
  }
}

Excluir

Endpoint

DELETE https://telinkei.com/api/links/{link_id}

Exemplo

curl --request DELETE \
--url 'https://telinkei.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Links

Recuperar tudo

Recuperar um

Criar

Atualizar

Excluir