Requests and responses

Edusign has a REST API the follow the JSON API Conventions.
You have to encode the body of your requests in JSON, don't forget to add the :

"Content-Type: application/json" header to your HTTP requests.

The REST API endpoint is https://ext.edusign.com.
The requests must be sent over HTTPS protocol.

We decided to separate the business errors from the technical ones.
This way, if the API responds correctly, the return code will always be 200.

The JSON response object, on the other hand, may contain a "success" or "error" status key, depending on whether the request was successful or not.

Error case

HTTP/1.2 200
{
  "status": "error",
  "message": "error message"
}

HTTP/1.2 200
{
  "status": "success",
  "result": ... // (string or object of the response)
}

In case of technical error, the API will send an error code :

401 : If the API Key is invalid or wrong

402 : If the account has a payment default, don't have a subscription or don't have the API Option in the subscription

403 : If the route is Forbidden (adjust the Key rights)

50x: Unknown server error, please contact Edusign support and provide the API Route and the JSON of the body.

📫
Contact our teams
If you are encountering error codes while making your requests, you can contact our technical team.