Assinaturas

Recuperar todos

GET https://xerp.ae/api/signatures/
curl --request GET \
--url 'https://xerp.ae/api/signatures/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo você está pesquisando. Os valores permitidos são: name.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar os resultados. Os valores permitidos são: signature_id, datetime, last_datetime, name.
order_type Opcional Cadeia 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 que 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, 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-07-15 20:12:33"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://xerp.ae/api/signatures?page=1",
        "last": "https://xerp.ae/api/signatures?page=1",
        "next": null,
        "prev": null,
        "self": "https://xerp.ae/api/signatures?page=1"
    }
}

Recuperar um

GET https://xerp.ae/api/signatures/{signature_id}
curl --request GET \
--url 'https://xerp.ae/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-07-15 20:12:33"
    }
}

Criar

POST https://xerp.ae/api/signatures
Parâmetros Detalhes Descrição
name Obrigatório Cadeia Nome
project_id Opcional Inteiro Um projeto ajudará você a categorizar seus recursos.
template Opcional Cadeia Valores permitidos: plain_text, mars, mercury, venus, nova
direction Opcional Cadeia Valores permitidos: ltr, rtl
is_removed_branding Opcional Boolean Remover marcação
image_url Opcional Cadeia Apenas utilize imagens JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia Sair
full_name Opcional Cadeia Nome completo
job_title Opcional Cadeia Título do trabalho
department Opcional Cadeia Departamento
company Opcional Cadeia Empresa
email Opcional Cadeia Email
website_name Opcional Cadeia Nome do site
website_url Opcional Cadeia URL do site
address Opcional Cadeia Endereço
address_url Opcional Cadeia Link para uma localização no Google Maps, por exemplo.
phone_number Opcional Cadeia Número de telefone
whatsapp Opcional Cadeia Whatsapp
facebook_messenger Opcional Cadeia Nome de usuário do Facebook Messenger
telegram Opcional Cadeia Nome de usuário do Telegram
disclaimer Opcional Cadeia Texto de aviso
font_family Opcional Cadeia 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 Cadeia Cor de fundo
border_color Opcional Cadeia Cor da borda
theme_color Opcional Cadeia Cor do tema
full_name_color Opcional Cadeia Cor da nome completo
text_color Opcional Cadeia Cor da fonte
link_color Opcional Cadeia Cor do link
facebook Opcional Cadeia Nome de usuário do Facebook
threads Opcional Cadeia Nome de usuário dos tópicos
x Opcional Cadeia Utilizador X
instagram Opcional Cadeia Nome de usuário do Instagram
youtube Opcional Cadeia Canal do YouTube
tiktok Opcional Cadeia Nome de usuário do TikTok
spotify Opcional Cadeia Nome de usuário do Spotify
pinterest Opcional Cadeia Nome de usuário do Pinterest
linkedin Opcional Cadeia Nome de usuário do LinkedIn
snapchat Opcional Cadeia Nome de usuário do Snapchat
twitch Opcional Cadeia Nome de usuário do Twitch
discord Opcional Cadeia ID do usuário do Discord
github Opcional Cadeia Nome de usuário do Github
reddit Opcional Cadeia Nome de usuário do Reddit
curl --request POST \
--url 'https://xerp.ae/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-07-15 20:12:33"
    }
}

Atualizar

POST https://xerp.ae/api/signatures/{signature_id}
Parâmetros Detalhes Descrição
name Opcional Cadeia Nome
project_id Opcional Inteiro Um projeto ajudará você a categorizar seus recursos.
template Opcional Cadeia Valores permitidos: plain_text, mars, mercury, venus, nova
direction Opcional Cadeia Valores permitidos: ltr, rtl
is_removed_branding Opcional Boolean Remover marcação
image_url Opcional Cadeia Apenas utilize imagens JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia Sair
full_name Opcional Cadeia Nome completo
job_title Opcional Cadeia Título do trabalho
department Opcional Cadeia Departamento
company Opcional Cadeia Empresa
email Opcional Cadeia Email
website_name Opcional Cadeia Nome do site
website_url Opcional Cadeia URL do site
address Opcional Cadeia Endereço
address_url Opcional Cadeia Link para uma localização no Google Maps, por exemplo.
phone_number Opcional Cadeia Número de telefone
whatsapp Opcional Cadeia Whatsapp
facebook_messenger Opcional Cadeia Nome de usuário do Facebook Messenger
telegram Opcional Cadeia Nome de usuário do Telegram
disclaimer Opcional Cadeia Texto de aviso
font_family Opcional Cadeia 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 Cadeia Cor de fundo
border_color Opcional Cadeia Cor da borda
theme_color Opcional Cadeia Cor do tema
full_name_color Opcional Cadeia Cor da nome completo
text_color Opcional Cadeia Cor da fonte
link_color Opcional Cadeia Cor do link
facebook Opcional Cadeia Nome de usuário do Facebook
threads Opcional Cadeia Nome de usuário dos tópicos
x Opcional Cadeia Utilizador X
instagram Opcional Cadeia Nome de usuário do Instagram
youtube Opcional Cadeia Canal do YouTube
tiktok Opcional Cadeia Nome de usuário do TikTok
spotify Opcional Cadeia Nome de usuário do Spotify
pinterest Opcional Cadeia Nome de usuário do Pinterest
linkedin Opcional Cadeia Nome de usuário do LinkedIn
snapchat Opcional Cadeia Nome de usuário do Snapchat
twitch Opcional Cadeia Nome de usuário do Twitch
discord Opcional Cadeia ID do usuário do Discord
github Opcional Cadeia Nome de usuário do Github
reddit Opcional Cadeia Nome de usuário do Reddit
curl --request POST \
--url 'https://xerp.ae/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-07-15 20:12:33",
        "datetime": "2026-07-15 20:12:33"
    }
}

Apagar

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