Introduction#

#OpenAPI Specification

The Signhost REST API is described using the OpenAPI Specification. This specification is available in YAML format and can be used to generate client libraries, documentation, and other tools.

Download: openapi.yaml

#Server Address

The REST API Base URL is: https://api.signhost.com

#Security

We require that all API requests are done over HTTPS. See the Authentication page for details on API authentication.

#Return codes

The REST API uses standard HTTP status codes.

In short this means that any status code in the range of:

• 2xx - your request was successful
• 4xx - there was an error in your request. You should not retry the request until you have corrected the error
• 5xx - there was an internal error in Signhost. You may retry this request at a later time. If you implement a retry policy you should use a backoff policy.

#Date Time Formats

JSON results which contain a date, time or datetime property are formatted according to ISO8601. A short explanation of the format is available at w3.org - Date and Time Formats.

#Libraries and demos

There are a few client libraries and demos available to make connecting to our API easier.

#Signhost Libraries

These libraries are built and maintained by Signhost:

• C# .Net Client Library
• C# .Net Client Library (Polly)

#Community Libraries

These libraries are built and maintained by the community:

• PHP - Laravel library (by NoardCode)
• Python Client Library

#Postman Workspace

Check out our public Postman workspace to make a quick start with testing - Postman workspace.