Glossary

Access Token

A temporary key generated using your credentials.

You must include it in API requests to prove you are authenticated.

It expires after a period of time and must be generated again.

API (Application Programming Interface)

A way for two systems to talk to each other.

API Credentials

The three secret values required to prove your system is allowed to use the API:

• api_key
• client_id
• client_secret

Think of them like a username and password for your system.

Application (in API settings)

A registered connection between your system and the QuicklySign API.

When you create one, you receive a client_id and client_secret.

Authenticate / Authentication

The process of proving who you are before accessing the API.

Automation

Using code to make something happen automatically without manual work.

Auto Request Signatures

A setting that automatically sends signing requests once the document pack is ready.

Base64 Document

A document that has been converted into text format so it can be safely sent inside a request.

Base URL

The main website address that all API requests start with.

Example:

https://sandboxapi.quicklysign.com

Cache-Control

A header that tells the system not to store (cache) the request.

client_id

An ID that identifies your specific application.

client_secret

A private secret linked to your application.

Note: This must never be shared publicly.

Document Pack

A container (or envelope) that groups one or more documents together for signing.

Endpoint

The full URL you send a request to.

Example:

https://sandboxapi.quicklysign.com/v1/document_packs

Extract Fields by Tag

A setting that tells the system to automatically detect and create fields in the document based on predefined tags.

Generate Signing URL

A setting that tells the system to return a signing link immediately instead of only sending email.

Headers

Extra technical information sent with an API request or response.

HTTP Method (GET, POST, PUT, DELETE)

The action you want to perform.

• GET – Retrieve information
• POST – Create something new
• PUT – Update something
• DELETE – Remove something

JSON

A simple text format used to send and receive data in APIs.

Pagination

When a large list of results is split into smaller pages instead of returning everything at once.

Postman

A tool that helps you test API requests without writing code.

Programmatically

Done by computer code rather than by a human clicking buttons.

Query Parameter

Extra information added to the end of a URL to change how the request behaves.

Example:

?always_use_http_status_code_200=true

Request

The information your system sends to the API.

Resource

A type of object you can work with in the API (for example: document packs or users).

Response

The information the API sends back to you.

RESTful API

A standard way for different software programs to communicate over the internet (like a universal language for apps).

Role

A label that links a signer to specific fields in a document.

Example:

"role": "signer-1"

Secure

The connection is protected and encrypted so other people cannot read the data.

Signing Request

An email sent to a signer asking them to sign a document.

Signing URL

A direct web link that opens the document signing page immediately.

Useful for testing because it skips the email step.

Standard Email Workflow

A process where the system sends an email to the signer with instructions to sign.

Status Code

A number that tells you whether a request succeeded or failed.

• 200 – Success
• 400 – Something was wrong with what you sent
• 401 – Authentication issue (not authorised)
• 500 – Server error

Version (v1)

A number that shows which version of the API you are using.

If the version changes, some things may work differently.

Workflow

The step-by-step process a document follows (for example: create, send, sign, complete).