Sirportly

Toggle Menu

API Documentation

Sirportly provides an API providing access to all the data stored within your account. Primarily, this API is used for managing ticket data however you can also retrieve lists of other meta objects (such as statuses, priorities etc...). This document outlines all the methods which are available with example output as well as which parameters can be passed to them.

API Endpoint

If you are using the hosted/cloud version of Sirportly, you should send all your API requests to api.sirportly.com. This request can be made using HTTP or HTTPS but we strongly recommend that you use HTTPS.

If you have the downloaded version, you should just send requests to the domain where you have installed Sirportly. The choice of HTTP/HTTPS depends on the configuration of your local web server.

Logging Requests

From the API Access area of the admin interface, you can enable or disable logging of requests. If logging is enabled, each request you make to the API using the token will be logged. The log will store various properties including the user agent, remote IP address, hostname & path requested as well as the parameters sent and, if enabled, the response the API provided.

We strongly recommend that this is disabled in any production applications and should only be used to help with development.

Passing & Receiving Data

  • All data is returned from the API in JSON format.
  • You may use any HTTP method when communicating with the API. We recommend using POST.
  • All parameters must be sent as standard HTTP params using the name outlined in the documentation.
  • The status of the request can be determined from the HTTP status code.
    • 200 OK - your request was successful and the appropriate data has been returned as JSON.
    • 201 Created - the object you were trying to create has been created successfully. The JSON representation of your new object will be returned as JSON.
    • 404 Not Found - the object you were requesting or an object you have tried to assign does not exist within your account. Further details are provided as JSON.
    • 403 Forbidden - the request could not be authenticated - your token/secret is invalid, the IP you are requesting from does not have access or you do not have access to the method. Further details are provided in the JSON.
    • 409 Conflict - you are not permitted to remove the requested object.
    • 422 Unprocessable Entity - a validation error has occurred which has prevented execution of your action.