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 Detalles Descripción
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo estás pesquisando. Los valores permitidos son: name.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre los resultados a partir desta fecha y hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre los resultados hasta esta fecha y hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar los resultados. Los valores permitidos son: signature_id, datetime, last_datetime, name.
order_type Opcional Cadeia A ordenação de los resultados. Los valores permitidos son: ASC para ordenação ascendente y DESC para ordenação descendente.
page Opcional Inteiro O número de la página que deseas resultados. O predeterminado es 1.
results_per_page Opcional Inteiro Quantos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. O predeterminado es 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 un

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"
    }
}

Crear

POST https://xerp.ae/api/signatures
Parámetros Detalles Descripción
name Obligatorio Cadeia Nombre
project_id Opcional Inteiro Un proyecto ayudará a categorizar tus 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 Solo utilize imágenes JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia Cerrar sesión
full_name Opcional Cadeia Nombre completo
job_title Opcional Cadeia Título del trabalho
department Opcional Cadeia Departamento
company Opcional Cadeia Empresa
email Opcional Cadeia Correo electrónico
website_name Opcional Cadeia Nombre del site
website_url Opcional Cadeia URL del site
address Opcional Cadeia Dirección
address_url Opcional Cadeia Enlace a una ubicación en Google Maps, por ejemplo.
phone_number Opcional Cadeia Número de teléfono
whatsapp Opcional Cadeia Whatsapp
facebook_messenger Opcional Cadeia Nombre de usuario del Facebook Messenger
telegram Opcional Cadeia Nombre de usuario del 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 Color de fondo
border_color Opcional Cadeia Color del borde
theme_color Opcional Cadeia Cor del tema
full_name_color Opcional Cadeia Cor de la nombre completo
text_color Opcional Cadeia Cor de la fonte
link_color Opcional Cadeia Cor del enlace
facebook Opcional Cadeia Nombre de usuario del Facebook
threads Opcional Cadeia Nombre de usuario de los temas
x Opcional Cadeia Usuario X
instagram Opcional Cadeia Nombre de usuario del Instagram
youtube Opcional Cadeia Canal del YouTube
tiktok Opcional Cadeia Nombre de usuario del TikTok
spotify Opcional Cadeia Nombre de usuario del Spotify
pinterest Opcional Cadeia Nombre de usuario del Pinterest
linkedin Opcional Cadeia Nombre de usuario del LinkedIn
snapchat Opcional Cadeia Nombre de usuario del Snapchat
twitch Opcional Cadeia Nombre de usuario del Twitch
discord Opcional Cadeia ID del usuario del Discolord
github Opcional Cadeia Nombre de usuario del Github
reddit Opcional Cadeia Nombre de usuario del 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"
    }
}

Actualizar

POST https://xerp.ae/api/signatures/{signature_id}
Parámetros Detalles Descripción
name Opcional Cadeia Nombre
project_id Opcional Inteiro Un proyecto ayudará a categorizar tus 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 Solo utilize imágenes JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia Cerrar sesión
full_name Opcional Cadeia Nombre completo
job_title Opcional Cadeia Título del trabalho
department Opcional Cadeia Departamento
company Opcional Cadeia Empresa
email Opcional Cadeia Correo electrónico
website_name Opcional Cadeia Nombre del site
website_url Opcional Cadeia URL del site
address Opcional Cadeia Dirección
address_url Opcional Cadeia Enlace a una ubicación en Google Maps, por ejemplo.
phone_number Opcional Cadeia Número de teléfono
whatsapp Opcional Cadeia Whatsapp
facebook_messenger Opcional Cadeia Nombre de usuario del Facebook Messenger
telegram Opcional Cadeia Nombre de usuario del 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 Color de fondo
border_color Opcional Cadeia Color del borde
theme_color Opcional Cadeia Cor del tema
full_name_color Opcional Cadeia Cor de la nombre completo
text_color Opcional Cadeia Cor de la fonte
link_color Opcional Cadeia Cor del enlace
facebook Opcional Cadeia Nombre de usuario del Facebook
threads Opcional Cadeia Nombre de usuario de los temas
x Opcional Cadeia Usuario X
instagram Opcional Cadeia Nombre de usuario del Instagram
youtube Opcional Cadeia Canal del YouTube
tiktok Opcional Cadeia Nombre de usuario del TikTok
spotify Opcional Cadeia Nombre de usuario del Spotify
pinterest Opcional Cadeia Nombre de usuario del Pinterest
linkedin Opcional Cadeia Nombre de usuario del LinkedIn
snapchat Opcional Cadeia Nombre de usuario del Snapchat
twitch Opcional Cadeia Nombre de usuario del Twitch
discord Opcional Cadeia ID del usuario del Discolord
github Opcional Cadeia Nombre de usuario del Github
reddit Opcional Cadeia Nombre de usuario del 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"
    }
}

Eliminar

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