Note: This is an advanced feature. Please contact firstname.lastname@example.org about pricing and availability.
Mariana Anemone can be installed using
2. Initialize the SDK
In order to begin using Mariana Anemone, you'll first need to initialize it with some basic configuration information. This method will return an object that should be used for all subsequent interaction with the SDK.
initialize(appId, clientId, baseUrl)
|yes||The URL where your Embedded App is hosted.|
3. Create the Embedded Component
Establish a connection with the Admin Application to enable cross-domain communication.
Note: This function should be called only once within your application. Repeated calls will result in errors.
4. Authenticate the User
In order to start making authenticated requests against the Mariana Tek Admin API, you will need to obtain an access token. For standalone apps this is done using an OAuth flow, but for Embedded Apps you can simply use the
getToken method from the SDK which will handle this for you. An active token for your App will be returned if the user has already accessed your application during the current session. If there is not an active token, the user will be redirected to begin the OAuth flow, and will be returned to the initial location once the flow is complete. We highly recommend using this method to obtain and retrieve stored access tokens to avoid common issues that arise when attempting to use third-party cookies in many browsers.
You can find a complete example that puts all of these steps together on GitHub.
Full SDK Reference
Retrieve a bearer token from the Admin Application that your embedded application can use to make authenticated requests for the current user. If this user does not yet have an active token for your application, this function will redirect the user to authenticate them and grant a new token, then return them to the point where they initiated the authentication flow with a usable token.
Returns the base URL for the API corresponding to the brand where your Embedded App has been accessed. This will be most useful if your application is used by multiple brands so that you can ensure you are using the correct endpoints for the context.
Redirect the user to the class roster page.
Redirect the user to a user profile page.
Redirect the Admin Application window to an external URL.