Important
An API is a technical resource for developers so you will need to be familiar with using RESTful APIs to participate in this beta.
Welcome to the closed beta of Sign In App's RESTful Client API. This API is designed to help you extend your Sign In App experience to include custom dashboards, business intelligence and integration with 3rd party applications. We will continue to support and expand this closed beta with regular updates and we encourage you to contact us at beta-support@signinapp.com with your feedback, questions and suggestions. If you'd like to request access to this beta please get in touch.
All API endpoints are protected and calls must be authenticated using the method described here.
key
and secret
used to authenticate with the API. Instructions for setting up a API Client can be found here.The base URI to be called can be found as part of the details when managing an API Client in the portal. Each endpoint
is specific to the Client space the client is created in. The host will look like backend.region-x.signinapp.com
and base URI will look like https://<your-client-api-host>/client-api/v1
.
Unless otherwise specified all endpoints receive and return JSON data.
Content-Type: application/json
This is usually due to all endpoints requiring the Content-Type
and Accept
header to be set to application/json
.
Setting these headers on all requests should provide the expected behaviour.
This might be due to incorrect request parameters being specified. When specifying IDs on resources that don't exist the endpoints will return a 404. Check the specified IDs are correct.
This describes the various terms used and their relationships within the Sign In App application.