This page provides an index for all of the different endpoints available from Baack. The reference docs are intended to provide detailed information for integration developers.
For specific use cases see the general documentation on how to combine these endpoints to solve specific issues.
Endpoint for managing API clients. Clients provide context for API integrations including bearer token access to Baack APIs as well as for OAuth clients integrated with your company.
Operations: C
Endpoint used to issue new bearer tokens for an API client. Actual the token is only returned on create and an obfuscated token is returned on read.
Operations: C R UD
Boolean (truthy) value item endpoint with support for managing boolean content items associated with an entity.
Operations: C R UD
Operations: R
Client identifiers (deduplication keys) are used to store domain scoped IDs associated with an identity. These can be used to support linking an identity across multiple systems.
Operations: C R UD
API entrypoint to list the companies that the authenticated request is authorised to access. The result is a page of companies and more may be available via the nextPage URL. The endpoint returns both the associated authenticated company as well as other companies the authenticated access is authorised to administer
Operations: R
Company endpoint with support for companies used both internally for account structure and CRM company representations. Baack supports Company structures under an Organisation. Each company includes it's own usage / billing context. Typically an organisation with an account will include a Company for test / development purposes as well as one for production. Baack keeps company related concepts separate and each company has it's own encryption setup for data encryption at rest for Customer Information.
Operations: C R UD
Date time item endpoint with support for managing date time items associated with an entity.
Operations: C R UD
Double precision floating point value endpoint for managing floating point values associated with an entity.
Operations: C R UD
Content entity endpoint with support for multiple content types associated with an entity. An Entity is analogous to a web page or screen in an app. The entity holds all content associated with a specific scope to render all content in a view. Entities are addressed with a UNIX style path selector. Entities support localisation and variants to support A/B content splits. Entities with variants overlay the default variant when selected on rendering. Entities also support the concept of publication state. When created entities are in a pre-publication draft state. Publication is handled by setting the state and publication time to allow for content to be scheduled for publication in the future. See the rendered entity endpoints for rendered views including template item expansion. This endpoint and associated items are intended for managing entities and their items rather than rendering the content.
Operations: C R UD
Entity list endpoint that is used for creating collections of entities e.g. for a blog listing.
Operations: C R UD
Endpoint used for viewing rendered content entities with content items transformed. This endpoint is intended to be used by content clients and supports access via roles. See the PermissionRole endpoint for details of creating a role with read access to the entity. Multiple clients can then be assigned the role which mustuse the READ permission label. This allows client access from installed apps using a restricted API Client as company level access tokens have admin permissions.
Operations: R
Endpoint for managing membership groups used for collections of identities with metadata associated with the group lifecycle. Groups can be used for general identity groups, permissions or even mailing list management as they support membership state with opt in context and opt out state
Operations: C R UD
Endpoint for managing group membership for specific identities including opt in and out support
Operations: C R UD
Endpoint with support for managing personal / identifiable information typically in the context of the CRM use case where the data about customers is managed
Operations: C R UD
Image item endpoint with support for creating image items with associated image assets. Images are posted separately via the imageitemfile endpoint once the image item is created. Files associated with the image item support multiple size formats.
Operations: C R UD
Endpoint for associating an image file with a image item in an entity. Use this endpoint to upload a file which will be distributed to content delivery edge points
Operations: C
Latitude / Longitude content endpoint used for creating points or lines with latitude longitude values.Creation of a polygon can be achieved by creating multiple points with a sort order for sequencing.
Operations: C R UD
Operations: D
The organisation endpoint is provided for completeness as a reference to the top level container for different representations in Baack. The organisation holds a number of client companies which in turn are the owners for most representations. Client companies have a defined organisation. These typically are associated with billing accounts etc.
Operations: R
Endpoint handling person details (an individual) associated with an identity. A person also has multiple associated representations like names, addresses.
Operations: C R UD
Endpoint handling names (alias) for people. This endpoint allows association of multiple names with a person as part of their identity.
Operations: C R UD
Endpoint for managing projects representing a collection of tasks with workflows
Operations: C R UD
Endpoint for managing roles with permissions for Role based access control. Roles can be associated with multiple identities and api clients to grant a role based permission set to associated resources
Operations: C R UD
Endpoint handling telephone numbers typically associated with an identity.
Operations: C R UD
Template content item endpoint with support for managing templates which are translated on rendering endpoint calls using the entity context and other included resources.
Operations: C R UD
Text content items endpoint with support for managing text items associated with an entity.
Operations: C R UD