https://api.zoomcatalog.com/auth/authorize
Intended Use
Retrieve the tokens required to populate the Authorization header for other ZOOMcatalog API Endpoints.
Return Types
Permitted HTTP Request Methods
POST
HTTP Request Headers
| Required | Name | Value |
|---|---|---|
| Yes | Content-Type | "application/json" |
Parameters
| Required | Name | Value | Location |
|---|---|---|---|
| Yes | grant_type | "authorization_code" | Request Body |
| Yes | client_id | <ZOOMcatalog_Client_ID> | Request Body |
| Yes | client_secret | <ZOOMcatalog_Client_Secret> | Request Body |
| No | for_username | <string>- unique identifier representing a user in your application | Request Body |
Errors
| Code | Description | Likely Cause |
|---|---|---|
| 400 | Wrong format in HTTP body, MUST be a valid and well-form JSON string | The POST body cannot be parsed into valid JSON |
| 400 | Following arguments are required: [List of required arguments] | One or more required parameters is missing |
| 400 | for_username parameter cannot be empty | for_username is present in the query string but has no value |
| 400 | grant_type is not supported | The POST body contains a grant_type other than "authorization_code" |
| 403 | Invalid CLIENT SECRET, please contact the administrator | The <ZOOMcatalog_Client_Secret> is malformed or properly formed but invalid |
| 404 | Invalid CLIENT_ID, please contact the administrator. | The <ZOOMcatalog_Client_ID> is malformed or properly formed but invalid |
| 500 | Description will vary | Error on the API Server |
Examples
Here is an example curl request for getting a user token
curl https://api.zoomcatalog.com/auth/authorize -H 'Content-Type: application/json' -d '{"client_id": "CLIENT_ID_VALUE", "client_secret": CLIENT_SECRET", grant_type: GRANT_TYPE_VALUE}'
The response you will see:
{"user_token"" "USER_TOKEN_VALUE", "access_token": "ACCESS_TOKEN_VALUE"}
This user token generated needs to be used in the end-point to autologin uri