Authentication
In the APIs, you have a username and an API key. The key also acts as your password to the APIs. You need to have an access token for making any further API calls, which you can receive by logging in manually or programmatically using these credentials.
Signzy APIs adhere to authentication defined by Swagger 2.0 specifications. Each call to the APIs should include an 'Authorisation' header or 'access_token' query parameter for authentication. need an authorization token to utilize the APIs.
For using Signzy APIs you have to first log in to Signzy System which is a simple Rest API(HTTPS) call with JSON parameters such as username and password. The following section mentions the data to be input, the expected output, and the meaning of fields in JSON.
Supported methods: POST
Base URL for Pre-Production: http://video-conf-demo.signzy.app/
Base URL for production: http://video-conf.signzy.app/
Key | Required/Optional | Data type | Description |
Header | | | |
Content-Type | Required | String | application/json |
Body | | | |
username | Required | String | The username provided for logging in. |
password | Required | String | The password to the username. |
A successful API request generates an HTTP 200 response. The response to a request where output format was specified as JSON, is a JSON array with a response status.
To get the authentication token, look at the following response having the parameter “id”.
Key | Data type | Description |
id | String | This is your access token to be passed into other endpoints as an Authorization header |
ttl | String | **Time to live**for your token, which means for how much time this token will be valid from the time of the creation |
created | String | Time and date of creation of the application |
userId | String | The ID of the user |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].