List Apps on App Store

Copied

                https://api.ocamba.com/v2/ocamba/app-store

Returns a list of Apps on App store

query Parameters

Name

Description

fieldsstring

The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.

Example: fields=field1,field2,field3

viewstring

Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Example: view=full/default

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,filed2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.

idinteger

Unique identifier for the object defined as a query parameter.

Example: id=12346

titlestring

Title of the object.

Example: title=title1

typestring

Describe type of the object.

Example: type=type1

namestring

Name of the object.

Example: name=name1

statusstring

Describe status of the object.

Example: status=status1

create_timestring

Timezone: GMT.

Example: create_time=2021-09-14

update_timestring

Timezone: GMT.

Example: update_time=2021-09-14

is_publishedinteger

Describe publish status.

Example: is_published=1

Response status codes

200 - OK

Name

Description

items[ app-store ]

App Store

Name

Description

create_timedateTime

Timezone: GMT.

Example: 2021-11-25 13:45:03

descriptionstring

Additional information about an app.

Example: here goes description

idstring

A unique identifier generated by the Ocamba platform.

Example: 123456789

installed_versionstring

Installed version.

Example: 2.0.28

is_publishednumber (integer)

Describes application publish status.

Possible values: 0 | 1

logostring (uri)

Represent the logo of app.

Example: https://logo-uri-example.com

namestring

Represent name of the app.

Example: adex

planobject

Plan object.

published_versionstring

Latest published version.

Example: 1.0.10

rc_versionstring

Release candidate.

Example: 2.0.1

statusstring

titlestring

Represent the title of the app.

Example: AdExchange

trialobject

Trial object.

typestring

Describe app type.

Example: application

Possible values: application | spa

Default: application

update_timedateTime

Timezone: GMT.

Example: 2021-11-26 11:37:25

totalinteger

Example: 2

tip

1 Searchable fields are: title, description, rc_version and published_version.

2 Sortable fields are: id, type, title, name, create_time and update_time.

Response examples

Copied

200

{
  "total": 2,
  "items": [
    {
      "id": "1001",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "logo": "https://sm.ocmcore.com/share/6197120/ocamba/apps/adex/logo/adex.svg",
      "description": "Ocamba AdExchange is an automated bidding system with full machine learning for maximum efficiency in Ad campaign management.  It allows you to have full control over Ad display, with advanced targeting and statistics to improve and manage your campaign performance with ease. ",
      "published_version": "1.0.1",
      "rc_version": "2.0.28",
      "status": "active",
      "installed_version": "2.0.28",
      "create_time": "2021-02-17 15:29:25",
      "update_time": "2021-07-20 12:17:09"
    },
    {
      "id": "1005",
      "type": "application",
      "title": "Lorem Ipsum",
      "name": "loremipsum",
      "logo": "https://cdn2.iconfinder.com/data/icons/advertising-agency-malibu-vol-2/128/Open_Exchange-512.png",
      "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages.",
      "published_version": "1.0.8",
      "rc_version": "1.0.9",
      "status": "uninstalled",
      "installed_version": "1.0.9",
      "create_time": "2021-03-05 12:27:18",
      "update_time": "2021-04-13 13:48:06"
    }
  ] 
}

{
  "total": 2,
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "published_version": "1.0.10",
      "rc_version": "2.0.1",
      "status": "trial",
      "installed_version": "2.0.28",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

List Apps on App Store

GET /app-storeCopied https://api.ocamba.com/v2/ocamba/app-store

GET /app-store
Copied
`https://api.ocamba.com/v2/ocamba/app-store`