Signatures

Récupérer tous

GET https://xerp.ae/api/signatures/
curl --request GET \
--url 'https://xerp.ae/api/signatures/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Champ dans lequel vous effectuez la recherche. Les valeurs autorisées sont : name.
datetime_field Opcional Cadeia Valeures permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre les résultats a partir desta date et heure. Format Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre les résultats jusqu’à cette date et heure. Format Y-m-d H:i:s.
order_by Opcional Cadeia Champ selon lequel trier les résultats. Les valeurs autorisées sont : signature_id, datetime, last_datetime, name.
order_type Opcional Cadeia Ordre des résultats. Les valeurs autorisées sont : ASC pour l’ordre croissant et DESC pour l’ordre décroissant.
page Opcional Inteiro O numéro de la page que souhaitez résultats. O défaut est 1.
results_per_page Opcional Inteiro Nombre de résultats souhaités par page. Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. La valeur par défaut est 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:40"
        }
    ],
    "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"
    }
}

Récupérer 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:40"
    }
}

Créer

POST https://xerp.ae/api/signatures
Paramètres Détails Description
name Obligatoire Cadeia Nom
project_id Opcional Inteiro Informations relatives Ă  projet id aide.
template Opcional Cadeia Valeures permitidos: plain_text, mars, mercury, venus, nova
direction Opcional Cadeia Valeures permitidos: ltr, rtl
is_removed_branding Opcional Boolean Supprimer marcação
image_url Opcional Cadeia Uniquement utilize images JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia DĂ©connexion
full_name Opcional Cadeia Nom complet
job_title Opcional Cadeia Intitulé du poste
department Opcional Cadeia Departamento
company Opcional Cadeia Entreprise
email Opcional Cadeia E-mail
website_name Opcional Cadeia Nom du site
website_url Opcional Cadeia URL du site
address Opcional Cadeia Adresse
address_url Opcional Cadeia Lien pour une localisation dans le Google Maps, par exemplo.
phone_number Opcional Cadeia Numéro de téléphone
whatsapp Opcional Cadeia WhatsApp
facebook_messenger Opcional Cadeia Nom d’utilisateur du Facebook Messenger
telegram Opcional Cadeia Nom d’utilisateur du Telegram
disclaimer Opcional Cadeia Texte de avertissement
font_family Opcional Cadeia Valeures permitidos: arial, verdana, helvetica, times_new_roman, georgia
font_size Opcional Inteiro Valeures permitidos: 12-18
width Opcional Inteiro Valeures permitidos: 300-600
image_width Opcional Inteiro Valeures permitidos: 45-150
image_border_radius Opcional Inteiro Valeures permitidos: 0-100
socials_width Opcional Inteiro Valeures permitidos: 15-30
socials_padding Opcional Inteiro Valeures permitidos: 5-15
separator_size Opcional Inteiro Valeures permitidos: 0-5
border_radius Opcional Inteiro Valeures permitidos: 0-30
background_color Opcional Cadeia Couleur de fond
border_color Opcional Cadeia Couleur de bordure
theme_color Opcional Cadeia Couleur du thème
full_name_color Opcional Cadeia Couleur de la nom complet
text_color Opcional Cadeia Couleur de police
link_color Opcional Cadeia Couleur du lien
facebook Opcional Cadeia Nom d’utilisateur du Facebook
threads Opcional Cadeia Nom d’utilisateur des tópicos
x Opcional Cadeia Texte
instagram Opcional Cadeia Nom d’utilisateur du Instagram
youtube Opcional Cadeia Chaîne YouTube
tiktok Opcional Cadeia Nom d’utilisateur du TikTok
spotify Opcional Cadeia Nom d’utilisateur du Spotify
pinterest Opcional Cadeia Nom d’utilisateur du Pinterest
linkedin Opcional Cadeia Nom d’utilisateur du LinkedIn
snapchat Opcional Cadeia Nom d’utilisateur du Snapchat
twitch Opcional Cadeia Nom d’utilisateur du Twitch
discord Opcional Cadeia ID du utilisateur du Discord
github Opcional Cadeia Nom d’utilisateur du Github
reddit Opcional Cadeia Nom d’utilisateur du 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:40"
    }
}

Mettre Ă  jour

POST https://xerp.ae/api/signatures/{signature_id}
Paramètres Détails Description
name Opcional Cadeia Nom
project_id Opcional Inteiro Informations relatives Ă  projet id aide.
template Opcional Cadeia Valeures permitidos: plain_text, mars, mercury, venus, nova
direction Opcional Cadeia Valeures permitidos: ltr, rtl
is_removed_branding Opcional Boolean Supprimer marcação
image_url Opcional Cadeia Uniquement utilize images JPG, JPEG, GIF, PNG.
sign_off Opcional Cadeia DĂ©connexion
full_name Opcional Cadeia Nom complet
job_title Opcional Cadeia Intitulé du poste
department Opcional Cadeia Departamento
company Opcional Cadeia Entreprise
email Opcional Cadeia E-mail
website_name Opcional Cadeia Nom du site
website_url Opcional Cadeia URL du site
address Opcional Cadeia Adresse
address_url Opcional Cadeia Lien pour une localisation dans le Google Maps, par exemplo.
phone_number Opcional Cadeia Numéro de téléphone
whatsapp Opcional Cadeia WhatsApp
facebook_messenger Opcional Cadeia Nom d’utilisateur du Facebook Messenger
telegram Opcional Cadeia Nom d’utilisateur du Telegram
disclaimer Opcional Cadeia Texte de avertissement
font_family Opcional Cadeia Valeures permitidos: arial, verdana, helvetica, times_new_roman, georgia
font_size Opcional Inteiro Valeures permitidos: 12-18
width Opcional Inteiro Valeures permitidos: 300-600
image_width Opcional Inteiro Valeures permitidos: 45-150
image_border_radius Opcional Inteiro Valeures permitidos: 0-100
socials_width Opcional Inteiro Valeures permitidos: 15-30
socials_padding Opcional Inteiro Valeures permitidos: 5-15
separator_size Opcional Inteiro Valeures permitidos: 0-5
border_radius Opcional Inteiro Valeures permitidos: 0-30
background_color Opcional Cadeia Couleur de fond
border_color Opcional Cadeia Couleur de bordure
theme_color Opcional Cadeia Couleur du thème
full_name_color Opcional Cadeia Couleur de la nom complet
text_color Opcional Cadeia Couleur de police
link_color Opcional Cadeia Couleur du lien
facebook Opcional Cadeia Nom d’utilisateur du Facebook
threads Opcional Cadeia Nom d’utilisateur des tópicos
x Opcional Cadeia Texte
instagram Opcional Cadeia Nom d’utilisateur du Instagram
youtube Opcional Cadeia Chaîne YouTube
tiktok Opcional Cadeia Nom d’utilisateur du TikTok
spotify Opcional Cadeia Nom d’utilisateur du Spotify
pinterest Opcional Cadeia Nom d’utilisateur du Pinterest
linkedin Opcional Cadeia Nom d’utilisateur du LinkedIn
snapchat Opcional Cadeia Nom d’utilisateur du Snapchat
twitch Opcional Cadeia Nom d’utilisateur du Twitch
discord Opcional Cadeia ID du utilisateur du Discord
github Opcional Cadeia Nom d’utilisateur du Github
reddit Opcional Cadeia Nom d’utilisateur du 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:40",
        "datetime": "2026-07-15 20:12:40"
    }
}

Supprimer

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