Getting Started with Cloud Elements

By Sunny Harmon in GET/technical Posted Aug 24, 2018

New to Cloud Elements and not sure where to begin? As a Delivery Manager who helps customers get started with the Cloud Elements platform and their first integration I have compiled a few helpful tips below on how to familiarize yourself with the platform. The more of a expert you are with Cloud Elements, the more efficient you will be with each of your integrations.

blog-banners-04
Cloud Elements Platform - familiarize yourself with the Platform APIs

The platform APIs will be used to manage your account, access logs, monitor your account and fully utilize Cloud Elements to customize and automate your customers experience for each integration. Anything you can do in the Cloud Elements UI you can do via API for your customers. Below I describe a few ways to use a few of my favorite platform APIs to get started.

What is an easy way to find all available elements?

Below is the API to get you a full list of Elements available. Not only will you get a list of all the Elements, but the results contain important information, like the ID, name, key and description. The ID, key are used in many of the platform API calls.

GET /elements
(https://staging.cloud-elements.com/elements/api-v2/elements)

 
How do I get the ID or Key for an individual element?

The easiest way to find the ‘id’ for a single Element is from the UI:

  1. Go to Elements,
  2. Then search for the Element,
  3. Hover over the Element and then click ‘Authenticate’,
  4. From the URL will be the ID. Example, ‘https://my-staging.cloudelements.io/elements/21/create
How to use swagger?

If you want to get sample payloads to understand what is required for each of the calls the best way to do this is using Swagger with the try it out feature. With this feature you will receive a sample curl command for the call, as well as, the response body and other parameter options like where clause and page requirements whenever available.

 
Where do I start to create the provision experience for my users?

There are several steps that happen in order to provision an Element for your customers. First you will need to know what kind of authentication is available for the Cloud Elements' Element and what fields are required, which is fairly simple using the API below.

GET/elements/{keyOrId}/configuration
(https://staging.cloud-elements.com/elements/api-v2/elements/88/configuration)

Here are two small samples data for this include:

 

Now you will still need to decide what fields to expose to your clients, possibly create Oauth Applications, and POST / instance to create a single authenticated instance. But the start to authenticating is understanding what is required to authenticate. Here are few blogs that provide some of that additional context:

 
What information should I save when authenticating an instance?

The best practice is to have User Organization, User Secret, and Instance Token. If you want to store less than this, then you should discuss your use case with the Cloud Elements Implementation team.

These are just a few of the Platform APIs to get you started, there are lots of other features that I have not shared with you, but check out the Cloud Element YouTube channel, specifically the “How to” videos and watch how to’s on Virtual Data Resources (VDRs) and a full UI demo for Cloud Elements 2.0. 

Good luck and remember we have a great support and implementation team that can help you along the way.  (And not yet a Cloud Elements customer? Signup for a 30day free trial). 

30 Day Free Trial >