Actions of Integration for Adobe (FSCADOBE@1.1001)

ReferenceName
FSCADOBE@1.1001:DoAPIDownloadRequest
FSCADOBE@1.1001:DoAPIGetRequest
FSCADOBE@1.1001:EncodeJWT
FSCADOBE@1.1001:FetchOAuthTokenData
FSCADOBE@1.1001:GetAssetDetailProperties
FSCADOBE@1.1001:GetAssetDetails
FSCADOBE@1.1001:GetDownloadFileName
FSCADOBE@1.1001:GetOAuthToken
FSCADOBE@1.1001:GetOAuthTokenData
FSCADOBE@1.1001:GetPluginInfo
FSCADOBE@1.1001:MapMIMEType2FileExt
FSCADOBE@1.1001:MeasureAdobeStock
FSCADOBE@1.1001:PersistOAuthTokenData
FSCADOBE@1.1001:PrepareRequestHeaders
FSCADOBE@1.1001:RefreshOAuthToken
FSCADOBE@1.1001:StockAPIAuthInit
FSCADOBE@1.1001:StockAPIAuthRedirect
FSCADOBE@1.1001:StockAPIDownloadAssetByID
FSCADOBE@1.1001:StockAPIDownloadAssetByLink
FSCADOBE@1.1001:StockAPIFetchServiceUserAccessToken
FSCADOBE@1.1001:StockAPIGetContentInfo
FSCADOBE@1.1001:StockAPIGetContentLicense
FSCADOBE@1.1001:StockAPIGetLicenseHistory
FSCADOBE@1.1001:StockAPIGetProfile
FSCADOBE@1.1001:StockAPISearch
FSCADOBE@1.1001:StockPairOAuth
FSCADOBE@1.1001:StockPairOAuthFinished

FSCADOBE@1.1001:DoAPIDownloadRequest

FSCADOBE@1.1001:DoAPIDownloadRequest is internally used to handle various Adobe Stock API download requests
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
urlCOOSYSTEM@1.1:STRINGinfalse the called endpoint URL
resphdrsCOOSYSTEM@1.1:DICTIONARYouttrue
responseCOOSYSTEM@1.1:CONTENToutfalse The downloaded file as a content

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:DoAPIGetRequest

FSCADOBE@1.1001:DoAPIGetRequest is internally used to handle Adobe Stock API "GET"-requests
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
urlCOOSYSTEM@1.1:STRINGinfalse the called endpoint URL
responseCOOSYSTEM@1.1:DICTIONARYoutfalse The JSON-response encoded as a dictionary

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:EncodeJWT

FSCADOBE@1.1001:EncodeJWT creates a signed JWT based on the given data that can be used to fetch a valid access token from the Adobe IMS service
ParameterTypeIn/OutOptionalDescription
payloadFSCADOBE@1.1001:JWTClaimsinfalse The needed JWT claims
algFSCADOBE@1.1001:JWTSignatureAlgorithminfalse The desired signature algorithm
hmackeyCOOSYSTEM@1.1:STRINGintrue The signature key when using an HMAC algorithm
rsacertCOOSYSTEM@1.1:CONTENTintrue The PSE encoded certificate when using an RSA signature algorithm
jwttokenCOOSYSTEM@1.1:STRINGouttrue The encoded and optionally signed JWT token

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:FetchOAuthTokenData

FSCADOBE@1.1001:FetchOAuthTokenData calls the Adobe IMS "fetch token" method using the given connection conn and the code that was redirected from Adobe authorization request
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the token data shall be fetched
codeCOOSYSTEM@1.1:STRINGinfalse The code that was given back from Adobes authorization portal
accdataCOOSYSTEM@1.1:DICTIONARYoutfalse The token data that Adobe's API method returned

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:GetAssetDetailProperties

FSCADOBE@1.1001:GetAssetDetailProperties returns asset properties that are displayed in the details-view in the Fabasoft Cloud Plugin within Adobe CC tools This Method is called via a webservice call from within the plugin and is overridden from the delivering components of each asset object class
ParameterTypeIn/OutOptionalDescription
propertiesCOOSYSTEM@1.1:DICTIONARYLISToutfalse a dictionary containing the properties to display

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:GetAssetDetails

FSCADOBE@1.1001:GetAssetDetails is called from the Adobe CC plugin to fetch data that should be visualized when showing the details of an asset
ParameterTypeIn/OutOptionalDescription
objidCOOSYSTEM@1.1:STRINGinfalse The desired assets object address
detailsCOOSYSTEM@1.1:DICTIONARYoutfalse The result data-dictionary describing details of the asset

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:GetDownloadFileName

FSCADOBE@1.1001:GetDownloadFileName is internally used to get the filename that Adobe defined for a downloaded asset file
ParameterTypeIn/OutOptionalDescription
resphdrsCOOSYSTEM@1.1:DICTIONARYinfalse http response headers of the performed asset download
filenameCOOSYSTEM@1.1:STRINGoutfalse extracted filename

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:GetOAuthToken

FSCADOBE@1.1001:GetOAuthToken lets the current user retrieve a formerly required OAuth access token that was securely persisted in the users settings If the token will expire within the next 5 minutes it is automatically refreshed via the also persisted refresh token
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the token shall be returned
tokenCOOSYSTEM@1.1:STRINGoutfalse A valid access token that is needed can be used to call adobe stock API methods

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:GetOAuthTokenData

FSCADOBE@1.1001:GetOAuthTokenData reads the securely persisted authentication data for the given connection conn
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the token data shall be returned
tokendataFSCADOBE@1.1001:OAuthTokenDataoutfalse The token data that was persisted for the given connection conn

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:GetPluginInfo

FSCADOBE@1.1001:GetPluginInfo is called from the Adobe CC plugin to fetch data used to initialize the plugin when booting
ParameterTypeIn/OutOptionalDescription
PluginIdCOOSYSTEM@1.1:STRINGinfalse The ID of the calling plugin
plugininfoCOOSYSTEM@1.1:DICTIONARYoutfalse The result data-dictionary to initialize the plugin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:MapMIMEType2FileExt

Adobe Stock related mapping function to map a given MIME-type to a file extension
ParameterTypeIn/OutOptionalDescription
mimetypeCOOSYSTEM@1.1:STRINGinfalse The MIME-type that should be mapped
fileextCOOSYSTEM@1.1:STRINGoutfalse The resulting file extension

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:MeasureAdobeStock

FSCADOBE@1.1001:MeasureAdobeStock does a series of API calls to get some statistical data of the Adobe Stock Cloud Repository (eg. number of Assets of each type, ...)
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
infoCOOSYSTEM@1.1:DICTIONARYoutfalse A dictionary containing the statistical data

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:PersistOAuthTokenData

FSCADOBE@1.1001:PersistOAuthTokenData persists the data given in parameter fetchtokenresult securely in the current users settings
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the token data shall be persisted
fetchtokenresultCOOSYSTEM@1.1:DICTIONARYinfalse The token data that shall be persisted

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:PrepareRequestHeaders

FSCADOBE@1.1001:PrepareRequestHeaders is internally used to prepare http-headers for various http-requests against the Adobe Stock API
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
genauthhdrCOOSYSTEM@1.1:BOOLEANinfalse
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
hdrsCOOSYSTEM@1.1:DICTIONARYoutfalse A dictionary containing all needed http-headers

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:RefreshOAuthToken

FSCADOBE1.1001:RefreshOAuthToken does an Adobe API call to refresh a formerly requested OAuth token
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the token data shall be refreshed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:StockAPIAuthInit

FSCADOBE@1.1001:StockAPIAuthInit will be called from the OAuth pairing application to initiate the redirect to Adobes IMS where the authentication and authorization is performed
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the authentication will be performed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:StockAPIAuthRedirect

FSCADOBE@1.1001:StockAPIAuthRedirect will be called from an Adobe authorization request's http-redirect
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the authentication was performed
codeCOOSYSTEM@1.1:STRINGinfalse If the authentication was successful Adobe redirects back to Fabasoft Cloud with a valid code
errorCOOSYSTEM@1.1:STRINGinfalse If the authentication failed or the user canceled it Adobe redirects back with an error

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCADOBE@1.1001:StockAPIDownloadAssetByID

FSCADOBE@1.1001:StockAPIDownloadAssetByID does an authenticated Adobe Stock API call to the /Rest/Libraries/Download endpoint and returns the downloaded file as a content For this endpoint Adobe Stock returns a http 302 redirect response that will automatically be followed to do the file download
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to Access the API service
stockidCOOSYSTEM@1.1:STRINGinfalse The unique Adobe Stock content ID
assetCOOSYSTEM@1.1:CONTENToutfalse The returned asset file
downloadfilenameCOOSYSTEM@1.1:STRINGouttrue the filename encoded in the HTTP response header "Content-Disposition"

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIDownloadAssetByLink

FSCADOBE@1.1001:StockAPIDownloadAssetByLink does an authenticated Adobe Stock API call to the various endpoints that are embedded in other JSON-responses some samples are: - standard embedded content download: https://stock.adobe.com/Rest/Libraries/Download/76976826/1 - watermarked image embedded download: https://stock.adobe.com/Rest/Libraries/Watermarked/Download/76976826/1 - thumbnail image download: https://as1.ftcdn.net/jpg/00/76/97/68/500_F_76976826_2ieptCgXaldvSGz57bNOITMwUizbeWYW.jpg - "directly" tagged download: https://stock.adobe.com/Download/DownloadFileDirectly/NoZDUqYzP9mnfbV5DaIWmBkDerJqXqSl
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
downloadurlCOOSYSTEM@1.1:STRINGinfalse A content download endpoint returned from a preceeding API call
assetCOOSYSTEM@1.1:CONTENToutfalse The returned asset file
downloadfilenameCOOSYSTEM@1.1:STRINGouttrue the filename encoded in the HTTP response header "Content-Disposition"

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIFetchServiceUserAccessToken

FSCADOBE@1.1001:StockAPIFetchServiceUserAccessToken fetches a valid access token to use subsequent calls to the Adobe Stock API based on a service user account access Therefore a JWT-Token using the given connection data conn is assambled, signed and sent to the Adobe IMS
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for connecting, creating the JWT token, sign it and post it to the Adobe IMS service
accesstokenCOOSYSTEM@1.1:STRINGoutfalse The access token returned by Adobe Stock IMS service to be used for subsequent API calls

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIGetContentInfo

FSCADOBE@1.1001:StockAPIGetContentInfo does an authenticated Adobe Stock API call to the /Rest/Libraries/1/Content/Info endpoint and returns the JSON-response as a dictionary For further details see Adobes online documentation https://github.com/adobe/stock-api-docs/blob/master/docs/api/12-licensing-reference.md
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
stockidCOOSYSTEM@1.1:STRINGinfalse The unique Adobe Stock content ID
contentinfoCOOSYSTEM@1.1:DICTIONARYoutfalse The returned JSON-data

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIGetContentLicense

FSCADOBE@1.1001:StockAPIGetContentLicense does an authenticated Adobe Stock API call to the /Rest/Libraries/1/Content/License endpoint and returns the JSON-response as a dictionary For further details see Adobes online documentation https://github.com/adobe/stock-api-docs/blob/master/docs/api/12-licensing-reference.md
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
stockidCOOSYSTEM@1.1:STRINGinfalse The unique Adobe Stock content ID
contentlicenseinfoCOOSYSTEM@1.1:DICTIONARYoutfalse The returned JSON-data

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIGetLicenseHistory

FSCADOBE@1.1001:StockAPIGetLicenseHistory does an authenticated Adobe Stock API call to the /Rest/Libraries/1/Member/LicenseHistory endpoint and returns the JSON-Response as a dictionary For further details see Adobes online documentation https://github.com/adobe/stock-api-docs/blob/master/docs/api/12-licensing-reference.md
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
limitCOOSYSTEM@1.1:INTEGERintrue Number of maximum history entries
offsetCOOSYSTEM@1.1:INTEGERintrue Offset to set up in subsequent aka "paged" calls
historydataCOOSYSTEM@1.1:DICTIONARYoutfalse The returned JSON-data

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPIGetProfile

FSCADOBE@1.1001:StockAPIGetProfile does an authenticated Adobe Stock API call to the /Rest/Libraries/1/Member/Profile endpoint and returns the JSON-response as a dictionary For further details see Adobes online documentation https://github.com/adobe/stock-api-docs/blob/master/docs/api/12-licensing-reference.md
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
profiledataCOOSYSTEM@1.1:DICTIONARYoutfalse The returned JSON-data

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockAPISearch

FSCADOBE@1.1001:StockAPISearch does an authenticated Adobe Stock API call to the /Rest/Media/1/Search/Files endpoint and returns the JSON-response as a dictionary For further details see Adobes online documentation https://github.com/adobe/stock-api-docs/blob/master/docs/api/11-search-reference.md
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection parameters used for calling the Adobe Stock API
accesstokenCOOSYSTEM@1.1:STRINGinfalse The access token to access the API service
limitCOOSYSTEM@1.1:INTEGERintrue Number of maximum history entries
offsetCOOSYSTEM@1.1:INTEGERintrue Offset to set up in subsequent aka "paged" calls
filterFSCADOBE@1.1001:SearchFilterintrue Filter criteria to precise the search request for requesting a narrower search result
searchresultCOOSYSTEM@1.1:DICTIONARYoutfalse The complete JSON-response containing the search result
secondtryCOOSYSTEM@1.1:BOOLEANintrue Indicates that this is the second attempt to connect to Adobe Stock

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockPairOAuth

Application to perform an OAuth-authentication handshake for the current user. The user gets redirected to Adobe authentication portal and if he wasn´t logged in previously has to enter his Adobe Account credentials to authorize Fabasoft Cloud to retrieve an access token. The authentication data is stored invisible and sensible secured in the current users settings. The access token that is needed to perform subsequent API calls can be retrieved via action FSCADOBE@1.1001:GetOAuthToken
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the authentication is performed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCADOBE@1.1001:StockPairOAuthFinished

Application that is executed after the OAuth-authentication handshake has successfully finished or failed
ParameterTypeIn/OutOptionalDescription
connCOOSYSTEM@1.1:OBJECTinfalse The connection object for which the authentication was performed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]