This document describes sundry information that is required for integration with avatar management. 

Requirements

None.

Interaction Diagram

The following diagram shows what the interaction between GX Tools and a product would look like.

Availability

Avatar Management APIs must made available via Cellophane on an internal instance, such as https://api.disney.private/ in the production environment.

Naming

APIs will follow the standard Cellophane naming scheme (see Path Token details on Cellophane Endpoint Record Reference. Please note that the version number must match that of the published API specification to avoid confusion.

Example: https://api.disney.private/<product>/uam/v1/ where <product> is the product name.

Authorization

Since Cellophane requires authorization, the following clients must be authorized to in the appropriate environments

Creating an Endpoint

See Create a Cellophane Endpoint for details on creating an end point. See below as an example specific to Avatar management.

Sequence Diagram (GET)

The sequence diagram below describes the order that data flows from the client to the product and back in a full loop to service a GET request. The sequence diagram for a PUT is also very similar.

The order of the GET request is as follows:

1. Client makes a request to getCategories endpoint. 
2. Server receives the GET request, checks authorization, logs the request and forwards on to the Product
3. Product process request and returns response in the forms of a data structure encapsulated in the response
4. Server passes response onto client

Sequence Diagram (PUT)

The sequence diagram for a PUT is also very similar. In a put request, the data being "put" to the RESTful endpoint needs to be passed in (in the form of parameters and/or body as required by the endpoint).

The order of the PUT request is as follows:

1. Client makes a request to /categories endpoint. 
2. Server receives the PUT request, validates it, checks authorization, logs the request and forwards on to the Product
3. Product process request and returns response in the forms of a data structure encapsulated in the response
4. Server passes response onto client