Kobble Authorization API

Overview

The Authorization API provides a secure mechanism to obtain an access token using the OAuth 2.0 client credentials flow. This access token is required to authenticate API requests in the system.

Base URLs

Use the appropriate base URL depending on the environment:

Development: https://dev.apikobble.net/

Staging: https://stage.apikobble.net/

Ensure you prepend the base URL to each endpoint while making requests.

Endpoint

URL:
oauth2/token

Method:
POST

Content-Type:
application/x-www-form-urlencoded

Request Parameters

Parameter	Type	Required	Description
`grant_type`	string	Yes	OAuth 2.0 grant type. Must be `client_credentials`.
`client_id`	string	Yes	The client identifier issued during registration.
`client_secret`	string	Yes	The secret key associated with the client.
`scope`	string	Yes	The access scope. Options are:
			- `client/read`
			- `client/write`
			- `administrator/read`
			- `administrator/write`

Sample Request

Sample Response

Authorization API Notes and Error Codes

Notes

The access_token is a JWT used to authenticate subsequent API requests.

The token's lifespan is defined in the expires_in field (in seconds). A new token must be requested once it expires.

The scope determines the level of access granted. Use the following based on your needs:

Read-only access:

client/read

administrator/read

Write access:

client/write

administrator/write

Keep your client_secret secure and never expose it in your application code or client-side scripts.

Error Codes

Status Code	Description
`400`	Bad Request - Invalid parameters or missing data.
`401`	Unauthorized - Invalid credentials or token.
`403`	Forbidden - The client is not allowed access to the requested resource.
`500`	Internal Server Error - An issue occurred on the server.

Authorization

Kobble Authorization API#

Overview#

Base URLs#

Endpoint#

Request Parameters#

Sample Request#

Sample Response#

Authorization API Notes and Error Codes#

Notes#

Error Codes#