Getting Started / Quick Start
Overview
To use the Xformative Portal and subsequently the Xformative API you will need to register and receive and invitation. Please proceed with the following steps to access the Xformative Portal.
1. First you need to register for access to the Xformative Developer Portal. In order to do that click the "Access to API" button in the top right hand corner of this page.
2. Once you are at the registration page fill in your registration details and submit a request for invitation.
3. Once approved you will receive an invitation email with a confirmation link. Click on that link to confirm your invitation and log in.
1. First you need to register for access to the Xformative Developer Portal. In order to do that click the "Access to API" button in the top right hand corner of this page.
2. Once you are at the registration page fill in your registration details and submit a request for invitation.
3. Once approved you will receive an invitation email with a confirmation link. Click on that link to confirm your invitation and log in.
API Keys
To use the Xformative API you will need to generate an API Key which you will use to make Xformative API Calls. Please proceed with the following steps to access the Xformative API.
1. On the left hand menu of the Xformative Portal click on Your Account > API Keys
2. Once you are on the API Keys page click the "Add" button on the grid.
3. The "Add API Key" form will slide in from the right side of the screen.
4. Fill in the "Add API Key" form and submit. Select "all-read-write" from the dropdown and input a key name of "My First Key".
5. The new API Key will now show in the grid. Copy the "Key Value" as you will use this to make Xformative API requests.
1. On the left hand menu of the Xformative Portal click on Your Account > API Keys
2. Once you are on the API Keys page click the "Add" button on the grid.
3. The "Add API Key" form will slide in from the right side of the screen.
4. Fill in the "Add API Key" form and submit. Select "all-read-write" from the dropdown and input a key name of "My First Key".
5. The new API Key will now show in the grid. Copy the "Key Value" as you will use this to make Xformative API requests.
Make API Requests
To make Xformative API calls you will use the "Key Value" you created in the API Keys section of this Quick Start. Please proceed with the following steps to make Xformative API Requests.
1. Pull up your favorite API client and fill use the following values to make the call.
Authorization: Bearer {place the key value here}
Method: GET
Route: /ping
Body: none
2. You should receive a response indicated you successfully pinged the service
1. Pull up your favorite API client and fill use the following values to make the call.
Authorization: Bearer {place the key value here}
Method: GET
Route: /ping
Body: none
2. You should receive a response indicated you successfully pinged the service
Type of business
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Business location
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Business representative
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Edit Business Owner
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Add Business Owner
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.