Assinaturas

Recuperar tudo

GET https://olinke.com/api/signatures/
curl --request GET \
--url 'https://olinke.com/api/signatures/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional String A string de busca.
search_by Opcional String Qual campo você está pesquisando? Os valores permitidos são: name.
datetime_field Opcional String Valores permitidos: datetime, last_datetime
datetime_start Opcional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional String Qual campo ordenar os resultados. Os valores permitidos são: signature_id, datetime, last_datetime, name.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página de onde você deseja os 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, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "project_id": 0,
            "name": "John Doe",
            "template": "mars",
            "settings": {
                "direction": "ltr",
                "is_removed_branding": true,
                "image_url": "",
                "sign_off": "Regards,",
                "full_name": "John Doe",
                "job_title": "Software Engineer",
                "department": "Engineering",
                "company": "Example Company",
                "email": "john@example.com",
                "website_name": "Example",
                "website_url": "https:\/\/example.com\/",
                "address": "123 Example Street",
                "address_url": "",
                "phone_number": "",
                "whatsapp": "",
                "facebook_messenger": "",
                "telegram": "",
                "disclaimer": "",
                "font_family": "arial",
                "font_size": 14,
                "width": 500,
                "image_width": 50,
                "image_border_radius": 0,
                "socials_width": 20,
                "socials_padding": 10,
                "separator_size": 0,
                "border_radius": 10,
                "background_color": "#f9f9f9",
                "border_color": "#e0e0e0",
                "theme_color": "#000000",
                "full_name_color": "#000000",
                "text_color": "#000000",
                "link_color": "#000000",
                "facebook": "johndoe",
                "threads": "johndoe",
                "x": "johndoe",
                "instagram": "johndoe",
                "youtube": "johndoe",
                "tiktok": "",
                "spotify": "",
                "pinterest": "",
                "linkedin": "",
                "snapchat": "",
                "twitch": "",
                "discord": "",
                "github": "",
                "reddit": ""
            },
            "last_datetime": null,
            "datetime": "2026-08-12 14:45:03"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://olinke.com/api/signatures?page=1",
        "last": "https://olinke.com/api/signatures?page=1",
        "next": null,
        "prev": null,
        "self": "https://olinke.com/api/signatures?page=1"
    }
}

Recuperar um

GET https://olinke.com/api/signatures/{signature_id}
curl --request GET \
--url 'https://olinke.com/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 0,
        "name": "Jane Doe",
        "template": "mars",
        "settings": {
            "direction": "ltr",
            "is_removed_branding": true,
            "image_url": "",
            "sign_off": "Regards,",
            "full_name": "Jane Doe",
            "job_title": "Software Engineer",
            "department": "Engineering",
            "company": "Example Company",
            "email": "jane@example.com",
            "website_name": "Example",
            "website_url": "https:\/\/example.com\/",
            "address": "123 Example Street",
            "address_url": "",
            "phone_number": "",
            "whatsapp": "",
            "facebook_messenger": "",
            "telegram": "",
            "disclaimer": "",
            "font_family": "arial",
            "font_size": 14,
            "width": 500,
            "image_width": 50,
            "image_border_radius": 0,
            "socials_width": 20,
            "socials_padding": 10,
            "separator_size": 0,
            "border_radius": 10,
            "background_color": "#f9f9f9",
            "border_color": "#e0e0e0",
            "theme_color": "#000000",
            "full_name_color": "#000000",
            "text_color": "#000000",
            "link_color": "#000000",
            "facebook": "janedoe",
            "threads": "janedoe",
            "x": "janedoe",
            "instagram": "janedoe",
            "youtube": "janedoe",
            "tiktok": "",
            "spotify": "",
            "pinterest": "",
            "linkedin": "",
            "snapchat": "",
            "twitch": "",
            "discord": "",
            "github": "",
            "reddit": ""
        },
        "last_datetime": null,
        "datetime": "2026-08-12 14:45:03"
    }
}

Criar

POST https://olinke.com/api/signatures
Parâmetros Detalhes Descrição
name Requerido String Nome
project_id Opcional Inteiro Um projeto ajudará você a categorizar seus recursos.
template Opcional String Valores permitidos: plain_text, mars, mercury, venus, nova
direction Opcional String Valores permitidos: ltr, rtl
is_removed_branding Opcional Boolean Remove branding
image_url Opcional String Only use JPG, JPEG, GIF, PNG images.
sign_off Opcional String Sign off
full_name Opcional String Full name
job_title Opcional String Job title
department Opcional String Department
company Opcional String Company
email Opcional String Email
website_name Opcional String Website name
website_url Opcional String Website URL
address Opcional String Address
address_url Opcional String Link to a Google maps location, for example.
phone_number Opcional String Phone number
whatsapp Opcional String WhatsApp
facebook_messenger Opcional String Facebook messenger username
telegram Opcional String Telegram username
disclaimer Opcional String Disclaimer text
font_family Opcional String Valores permitidos: arial, verdana, helvetica, times_new_roman, georgia
font_size Opcional Inteiro Valores permitidos: 12-18
width Opcional Inteiro Valores permitidos: 300-600
image_width Opcional Inteiro Valores permitidos: 45-150
image_border_radius Opcional Inteiro Valores permitidos: 0-100
socials_width Opcional Inteiro Valores permitidos: 15-30
socials_padding Opcional Inteiro Valores permitidos: 5-15
separator_size Opcional Inteiro Valores permitidos: 0-5
border_radius Opcional Inteiro Valores permitidos: 0-30
background_color Opcional String Background color
border_color Opcional String Border color
theme_color Opcional String Theme color
full_name_color Opcional String Full name color
text_color Opcional String Text color
link_color Opcional String Link color
facebook Opcional String Facebook username
threads Opcional String Threads username
x Opcional String X username
instagram Opcional String Instagram username
youtube Opcional String YouTube channel
tiktok Opcional String TikTok username
spotify Opcional String Spotify username
pinterest Opcional String Pinterest username
linkedin Opcional String LinkedIn username
snapchat Opcional String Snapchat username
twitch Opcional String Twitch username
discord Opcional String Discord user id
github Opcional String Github username
reddit Opcional String Reddit username
curl --request POST \
--url 'https://olinke.com/api/signatures' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Jane Doe' \
--form 'template=nova' \
--form 'full_name=Jane Doe' \
--form 'job_title=Software Engineer' \
--form 'company=Example Company' \
--form 'email=jane@example.com' \
--form 'background_color=#f8fafc' \
--form 'border_color=#cbd5e1' \
--form 'theme_color=#2563eb' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 0,
        "name": "Jane Doe",
        "template": "nova",
        "settings": {
            "direction": "ltr",
            "is_removed_branding": false,
            "image_url": "",
            "sign_off": "Regards,",
            "full_name": "Jane Doe",
            "job_title": "Software Engineer",
            "department": "",
            "company": "Example Company",
            "email": "jane@example.com",
            "website_name": "",
            "website_url": "",
            "address": "",
            "address_url": "",
            "phone_number": "",
            "whatsapp": null,
            "facebook_messenger": "",
            "telegram": "",
            "disclaimer": "",
            "font_family": "arial",
            "font_size": 14,
            "width": 500,
            "image_width": 50,
            "image_border_radius": 0,
            "socials_width": 20,
            "socials_padding": 10,
            "separator_size": 1,
            "border_radius": 10,
            "background_color": "#f8fafc",
            "border_color": "#cbd5e1",
            "theme_color": "#2563eb",
            "full_name_color": "#000000",
            "text_color": "#000000",
            "link_color": "#000000",
            "facebook": "",
            "threads": "",
            "x": "",
            "instagram": "",
            "youtube": "",
            "tiktok": "",
            "spotify": "",
            "pinterest": "",
            "linkedin": "",
            "snapchat": "",
            "twitch": "",
            "discord": "",
            "github": "",
            "reddit": ""
        },
        "last_datetime": null,
        "datetime": "2026-08-12 14:45:03"
    }
}

Atualizar

POST https://olinke.com/api/signatures/{signature_id}
Parâmetros Detalhes Descrição
name Opcional String Nome
project_id Opcional Inteiro Um projeto ajudará você a categorizar seus recursos.
template Opcional String Valores permitidos: plain_text, mars, mercury, venus, nova
direction Opcional String Valores permitidos: ltr, rtl
is_removed_branding Opcional Boolean Remove branding
image_url Opcional String Only use JPG, JPEG, GIF, PNG images.
sign_off Opcional String Sign off
full_name Opcional String Full name
job_title Opcional String Job title
department Opcional String Department
company Opcional String Company
email Opcional String Email
website_name Opcional String Website name
website_url Opcional String Website URL
address Opcional String Address
address_url Opcional String Link to a Google maps location, for example.
phone_number Opcional String Phone number
whatsapp Opcional String WhatsApp
facebook_messenger Opcional String Facebook messenger username
telegram Opcional String Telegram username
disclaimer Opcional String Disclaimer text
font_family Opcional String Valores permitidos: arial, verdana, helvetica, times_new_roman, georgia
font_size Opcional Inteiro Valores permitidos: 12-18
width Opcional Inteiro Valores permitidos: 300-600
image_width Opcional Inteiro Valores permitidos: 45-150
image_border_radius Opcional Inteiro Valores permitidos: 0-100
socials_width Opcional Inteiro Valores permitidos: 15-30
socials_padding Opcional Inteiro Valores permitidos: 5-15
separator_size Opcional Inteiro Valores permitidos: 0-5
border_radius Opcional Inteiro Valores permitidos: 0-30
background_color Opcional String Background color
border_color Opcional String Border color
theme_color Opcional String Theme color
full_name_color Opcional String Full name color
text_color Opcional String Text color
link_color Opcional String Link color
facebook Opcional String Facebook username
threads Opcional String Threads username
x Opcional String X username
instagram Opcional String Instagram username
youtube Opcional String YouTube channel
tiktok Opcional String TikTok username
spotify Opcional String Spotify username
pinterest Opcional String Pinterest username
linkedin Opcional String LinkedIn username
snapchat Opcional String Snapchat username
twitch Opcional String Twitch username
discord Opcional String Discord user id
github Opcional String Github username
reddit Opcional String Reddit username
curl --request POST \
--url 'https://olinke.com/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Jane Doe Signature' \
--form 'border_radius=16' \
--form 'background_color=#fff7ed' \
--form 'border_color=#fed7aa' \
--form 'theme_color=#c2410c' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 0,
        "name": "Jane Doe Signature",
        "template": "nova",
        "settings": {
            "direction": "ltr",
            "is_removed_branding": false,
            "image_url": "",
            "sign_off": "Regards,",
            "full_name": "Jane Doe",
            "job_title": "Software Engineer",
            "department": "",
            "company": "Example Company",
            "email": "jane@example.com",
            "website_name": "",
            "website_url": "",
            "address": "",
            "address_url": "",
            "phone_number": "",
            "whatsapp": null,
            "facebook_messenger": "",
            "telegram": "",
            "disclaimer": "",
            "font_family": "arial",
            "font_size": 14,
            "width": 500,
            "image_width": 50,
            "image_border_radius": 0,
            "socials_width": 20,
            "socials_padding": 10,
            "separator_size": 1,
            "border_radius": 16,
            "background_color": "#fff7ed",
            "border_color": "#fed7aa",
            "theme_color": "#c2410c",
            "full_name_color": "#000000",
            "text_color": "#000000",
            "link_color": "#000000",
            "facebook": "",
            "threads": "",
            "x": "",
            "instagram": "",
            "youtube": "",
            "tiktok": "",
            "spotify": "",
            "pinterest": "",
            "linkedin": "",
            "snapchat": "",
            "twitch": "",
            "discord": "",
            "github": "",
            "reddit": ""
        },
        "last_datetime": "2026-08-12 14:45:03",
        "datetime": "2026-08-12 14:45:03"
    }
}

Excluir

DELETE https://olinke.com/api/signatures/{signature_id}
curl --request DELETE \
--url 'https://olinke.com/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \