Overview

Overview

Jfamerwork exposes the following APIs for developers to consume in their applications.

Compatibility rules

Input parameters

• Requests are compatible irrespective of the order in which the query parameters appear.

• Requests are compatible irrespective of the order in which the properties of the JSON parameters appear.

• New query parameters may be added to future versions of requests.

• Existing query parameters can’t be removed from future versions of requests.

• Existing properties can’t be removed from the JSON parameters in future versions of requests.

JSON responses

• Responses are compatible irrespective of the order in which the properties appear.

• New properties may be added to future versions of the response.

• Existing properties can’t be removed from future versions of the response.

• Properties with null values may be omitted by responses.

Media types

The API currently supports only JSON as an exchange format. Be sure to set both the Content-Type and Accept headers for every request as application/json.

HTTP verbs

Where possible, the Jframework API strives to use appropriate HTTP verbs for each action.

Verb	Description
GET	Used to retrieve objects.
POST	Used to create objects or perform custom actions.
PUT	Used to replace objects or collections.
DELETE	Used to delete objects.

HTTP Code

The API uses standard HTTP status codes to indicate the success or failure of a request.

Standard HTTP Status Codes

Code	Meaning
200	OK - The request was successful.
201	Created - A new resource was created.
204	No Content - The request succeeded, no content returned.
400	Bad Request - The request was invalid.
401	Unauthorized - Authentication failed.
403	Forbidden - Access is not allowed.
404	Not Found - The resource was not found.
405	Method Not Allowed - HTTP verb not supported.
409	Conflict - A conflict occurred (e.g. duplicate).
429	Too Many Requests - Rate limit exceeded.
500	Internal Server Error - Unexpected server error.

Custom HTTP Codes

Code	Meaning
209	The user has exceeded the feature usage limit.
606	The input request username is invalid.
701	The provided password is invalid.
704	The user could not be found in the system.
723	The email address already exists in the system.
724	The username already exists in the system.
726	The phone number is already verified.
804	The verify authenticate with OTP operation failed because of expired OTP code.

Pagination

Requests that return a list of objects may support pagination. Pagination is implemented using a cursor-based system, rather than traditional page numbers. The cursor is an opaque value (not interpretable by the client) and is specified using either the pageNumber or pageSize query parameter.

Param	Description
pageNumber	Specifies the cursor for pagination. The value is opaque and client-specific.
pageSize	Specifies the number of items to return per page.

Response Object

The response object includes the following field:

• totalItems: The total number of items available across all pages.

Errors

Errors

Rate Limiting

Rate Limiting

Authentication

Authentication