Skip to content
SIGNESTO

DEVELOPER DOCUMENTATION

API documentation

Bring the power of SIGNESTO into your applications. A simple, secure, and comprehensive API to automate your professional email signatures.

Get started quicklyView examples
SIGNESTOAPI
POSThttps://api.signesto.com/v1/signatures
{  "name": "Nouvelle signature",  "template_id": "tpl_123456",  "user_id": "usr_789012",  "data": {    "first_name": "Julie",    "last_name": "Martin",    "job_title": "Responsable Marketing"  }}

  • A modern REST API that is easy to integrate

  • Secure and compliant with industry standards

  • Real-world examples in several languages

  • Documentation that is always up to date

Overview

The SIGNESTO API lets you programmatically manage all platform features: signatures, employees, templates, banners, and more.

  • Easy to integrate

    REST API with JSON

  • Secure

    OAuth 2.0 and API tokens

  • Complete

    All features

  • Always up to date

    New features released regularly

Getting started

Follow these simple steps to make your first API request in just a few minutes.

  1. 1

    Create an account

    Sign up for SIGNESTO and access your developer workspace.

  2. 2

    Get your keys

    Generate an API token from your account settings.

  3. 3

    Make your first request

    Test the API with our example below.

  4. 4

    Integrate and build

    Check the endpoint and SDK documentation.

Authentication

The API uses Bearer token authentication. You must include your token in the header of every request.

Authorization: Bearer votretoken_api

Your API tokens are available in your account settings. Keep them confidential and never share them.

Request example

Here is an example of creating a signature with cURL, JavaScript, and Python.

curl -X POST https://api.signesto.com/v1/signatures \  -H "Authorization: Bearer votretoken_api" \  -H "Content-Type: application/json" \  -d '{    "name": "Signature équipe commerciale",    "template_id": "tpl_123456",    "user_id": "usr_789012",    "data": {      "first_name": "Thomas",      "last_name": "Dubois",      "job_title": "Directeur Commercial"    }  }'

Sample response

{  "id": "sig_abc123def456",  "name": "Signature équipe commerciale",  "status": "active",  "html": "<div>...</div>",  "created_at": "2024-01-15T10:30:00Z",  "template_id": "tpl_123456",  "user_id": "usr_789012"}

Common parameters

The main parameters for creating a signature.

ParameterTypeRequiredDescription
namestringYesSignature name
template_idstringYesID of the template to use
user_idstringYesID of the user
dataobjectYesData to inject into the template
data.first_namestringYesEmployee's first name
data.last_namestringYesEmployee's last name
data.job_titlestringNoEmployee's job title
data.phonestringNoPhone
data.websitestringNoWebsite

Endpoints

Resources available at https://api.signesto.com. Each call is limited to the workspace of the API key used.

MethodPathDescription
GET/v1/signaturesList your employees' signatures
POST/v1/signaturesCreate a signature from a template
GET/v1/collaboratorsList your company's employees
POST/v1/collaboratorsAdd an employee
GET/v1/templatesList your signature templates
POST/v1/templatesCreate a signature template
GET/v1/campaignsList your banner campaigns
POST/v1/campaignsCreate a banner campaign

Webhooks

Receive a signed POST request at your URL for each signature event. Webhooks are configured from your workspace, using your API keys. Configure my webhooks

Error codes

The API uses standard HTTP codes. The body of each error is a JSON object describing the problem.

  • 400Invalid request: a parameter is missing or malformed
  • 401API key missing, invalid, or revoked
  • 402SIGNESTO subscription required (subscription_required)
  • 403Feature not included in your plan
  • 404Resource not found in your workspace
  • 429Too many requests: per-second limit (rate_limited) or monthly quota (quota_exceeded) reached
  • 500Internal error, please try again in a few moments

Rate limits

The API is included in the SIGNESTO subscription (48-hour trial included): 1,000 requests per month per workspace, and 10 requests per second per API key.

Above 10 requests per second, the API responds 429 rate_limited: wait for the time given in the Retry-After header before retrying the request.

The monthly quota resets on the 1st of each month (UTC). Once the 1,000 requests are used, the API responds 429 quota_exceeded with a Retry-After header until the next month. Without an active subscription it responds 402 subscription_required.

Interactive API reference

Official SDKs

Use our SDKs for even easier integration.

  • JavaScript / Node.js

    sdk-signesto

    Quick install with npm.

    npm install @signesto/sdk

  • Python

    signesto-python

    An official library for Python.

    pip install signesto

  • PHP

    signesto-php

    Easily integrate into your PHP applications.

    composer require signesto

  • cURL

    HTTP requests

    Use cURL to quickly test the API.

    View examples

Environments

The API is available in several environments.

  • Production

    https://api.signesto.com

    Production environment for your applications.

  • Sandbox

    https://sandbox.api.signesto.com

    Test environment for your development work.

Changelog

The latest API news.

  1. v1.0.0First public release: API keys, signature endpoints, employees, templates and campaigns, webhooksNew

Frequently asked questions

Create a key from your workspace, under Integrations › API and webhooks. The full key is shown only once: copy it and store it somewhere safe.

Yes. The subscription includes 1,000 requests per month per workspace, and 10 requests per second per key. Beyond that, the API responds 429 with a Retry-After header.

Yes, the sandbox environment at https://sandbox.api.signesto.com lets you test your integration without touching your production signatures.

All responses are in JSON (UTF-8). Signatures also include their HTML rendering in the html field.

Need help?

Our team is here to support your integration.

Ready to integrate SIGNESTO into your applications?

Get started now and power up your signatures.

Get my API token
  • Simple
  • Fast
  • No commitment