Mobile app developers glossary
The words used in this section, explained for app developers. Each entry links to the page that explains it in full. The technical glossary of the whole documentation is in Glossary.
Contents
Content
| Term | Meaning | Read |
|---|---|---|
| Content class | The type of an item and its list of fields, identified by classIdentifier (folder, article) | Content classes for apps |
| Content object | One item; objectId in REST answers | How Exponential content reaches an app |
| Node (location) | A place of an object in the content tree; nodeId. An object can have several, one of them the main node | same |
| Field (attribute) | One value of an object, of one datatype | Fields and field values |
| Datatype | The kind of a field: ezstring, ezxmltext, ezimage and others; type in a field answer | same |
| Remote id | A string id of an object or node that can be kept stable across installations; objectRemoteId, nodeRemoteId | Node ids, remote ids and deep links |
| Version | A saved state of an object; reads return the published one | Drafts, preview and publishing |
| Locale | A language code such as eng-US or ger-DE, used by Translation and languageLocale | Multilingual content |
| URL alias | The readable address of a node on the site; fullUrl in a REST answer | Node ids, remote ids and deep links |
The REST API
| Term | Meaning | Read |
|---|---|---|
ezprestapi | The extension that serves the REST content API at v1 and v2 | REST API |
| Provider | The class that serves the routes of a prefix; ezp7xRestApiProvider for ezp and ezpl | Routes reference |
ezp, ezpl | The two prefixes of the content API: /api/ezp/... and its alias /api/ezpl/... | same |
| v1, v2 | The API versions in the path; reads at both, writes at v2 | API versions v1 and v2 |
| Response group | A part of the answer you ask for with ResponseGroups= (Metadata, Locations, Fields, FieldValues) | Response groups |
OutputFormat=xhtml | Asks for renderedOutput, the node rendered by a site template | Rendered XHTML output |
ezprestapiprovider | The deprecated older v1 extension, now a shim on top of ezprestapi | API versions v1 and v2 |
| Answer cache | The REST framework's server-side cache of GET answers, per user | Caching on the server |
Credentials
| Term | Meaning | Read |
|---|---|---|
| OAuth client | An application registered by an administrator in Setup > oAuth admin, with an identifier, a secret and a redirect address | OAuth2 authorization code flow |
| Authorization code | The short-lived code the authorize page sends to the redirect address | same |
| Access token, refresh token | What the token endpoint answers; the access token lives TokenTTL seconds | same |
oauth/authorize | The policy a user needs to allow an app | same |
| Personal API key | expk_..., made by a user for their own scripts, with scopes and a lifetime | Personal API keys for tools |
| Scope | What a personal API key may be used for: read, publish, edit, remove | same |
| expservices token | expt_..., a personal token for the remote services | expservices tokens in apps |
| Form token | The CSRF token a browser session needs for writes; not needed with a bearer token | Writing through expservices |
Remote services and ezjscore
| Term | Meaning | Read |
|---|---|---|
| ezjscore | The extension whose /ezjscore/call/ interface calls registered PHP functions and answers JSON | ezjscore server functions for your app |
| expservices | Over a thousand named services on top of ezjscore, called as exp<domain>::<method> | Calling expservices from an app |
| Envelope | The shape of every expservices answer: {"ok":true,"data":...,"meta":...} or {"ok":false,"error":...} | The envelope |
| Catalog | The list of every service with its arguments, from expservices::catalog | Calling expservices from an app |
| Image alias | A named size of an image (small, medium, large and the site's own), made on demand | Image aliases for screen sizes |
Server terms you will hear
| Term | Meaning | Read |
|---|---|---|
| Siteaccess | One configuration of the installation (a site, a language, the administration), chosen by host or path | Multilingual content |
| Role and policy | What a user may do: a role holds policies such as content/read, limited to sections or subtrees | Permissions for app users |
| Velocity | Exponential's own application server; after configuration changes it is restarted | Deploying with Velocity |
| Demo mode | A public demo that refuses administrator password changes | Demo mode |
| Audit trail | The record of key and token events, refusals and writes | Permissions for app users |
Related pages
- Mobile app developers FAQ
- Glossary
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.