Getting Started
Step 1
Request API Access
The first step in buiding an integration with the Atlas API is to request a Client ID and Client Secret to be used when making calls to the Atlas authorization servers.
For data privacy reasons, requests for API access must come from a Atlas customer. To get your Client ID and Client Secret, you will need to ask the Atlas customer that you're working with to send a request to apisupport@memberclicks.com. In the request, the customer will need to provide the following information:
- Customer Name: the Atlas customer's association/chamber name
- Requester Name: the name of the staff member making the request
- 3rd Party Name: your company's name (used in your ClientID)
- 3rd Party Email: your email address for us to include when replying with your credentials
Upon receiving the request, Atlas will validate the information provided and then reply to both you and the requesting staff member with your API credentials. The following information will be provided in the reply:
- Client ID: your Client ID value to be submitted when making authorization requests
- Client Secret: your Client Secret to be submitted when making authorization requests
- Tenant: the Tenant value(s) you have been granted access to
- API Base URI: the base API URI you will use when making requests
Step 2
Get an Access Token
Once you have received your API credentials, you're ready to make your first requests to the Atlas authorization and resource servers. A simple way to get started with making API requests is to use Postman to quickly and easily make your first API requests. Once you have your API request mechanism set up, we're ready to make an authorization request.
For this initial example, we'll make a simple authorization request using the Client Credentials grant type. For more information on the different API authorization workflows, visit the API Authorization page. Here's the basic structure of a Client Credentials authorization request (replace the bracketed values with the information in your credentials):
Host: www.weblinkauth.com
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&scope=PublicWebApi&client_id=[Client_ID]&client_secret=[Client_Secret]&response_type=token&acr_values=tenant:[Tenant]
The resulting response will look like the following example:
{
- "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImEzck1VZ01Gdjl0UGNsTGE2eUYzekFrZnF1RSIsImtpZCI6ImEzck1VZ01Gdjl0UGNsTGE2eUYzekFrZnF1RSJ9.eyJpc3MiOiJodHRwczovL3d3dy53ZWJsaW5rYXV0aC5jb20iLCJhdWQiOiJodHRwczovL3d3dy53ZWJsaW5rYXV0aC5jb20vcmVzb3VyY2VzIiwiZXhwIjoxNTIyMTAwNjc1LCJuYmYiOjE1MjIwOTcwNzUsImNsaWVudF9pZCI6IkNQaGlsbGlwc1Rlc3QiLCJzY29wZSI6IlB1YmxpY1dlYkFwaSJ9.B38z98IffaBiwfZM5dQMagUcazVj-ypfajXn0zdwRMeNWBnd9q2vKHuCvVLRMV5SIYtQn4M7aSi-1ZpJ6e-ruX4XmJXsKvYmv_x9jaGPipcVwfrqOA7qbbRG2wTJzdnKkwqFgr7k3RVOtC3rf_HfffEVxa8ZyVpi94wP-ispkhWrH8c7Mwd5-B0HnOpM_3eyH920ME9UEMW6ZJRwpl3GzcoJOlpXf0k33ttJLPGC819xsVK0B947xxffo-ZaQHVwn9B9mLbN3PFU97Jhiiron9x9fKsw5coeC8XcBsNvI-bFaMFeMc3mFA-Mi_194xPQjDq9B87-ri5eWuIvHwUIwg",
- "expires_in": 3600,
- "token_type": "Bearer"
Step 3
Make a Resource Request
Now that we have an access token, we're ready to make our first resource request. We'll start with a simple example that will return a search for Profiles flagged as a member. For this request, we'll also need the Atlas customer's base API URI to make our request.
The request header should provide the access token to the resource server, and the request URI will contain our search parameters. The following example uses the token from our above example and has the correct search criteria set for looking up member profiles:
Header: x-tenant=[Tenant]
Host: api-v1.weblinkconnect.com
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImEzck1VZ01Gdjl0UGNsTGE2eUYzekFrZnF1RSIsImtpZCI6ImEzck1VZ01Gdjl0UGNsTGE2eUYzekFrZnF1RSJ9.eyJpc3MiOiJodHRwczovL3d3dy53ZWJsaW5rYXV0aC5jb20iLCJhdWQiOiJodHRwczovL3d3dy53ZWJsaW5rYXV0aC5jb20vcmVzb3VyY2VzIiwiZXhwIjoxNTIyMTAwNjc1LCJuYmYiOjE1MjIwOTcwNzUsImNsaWVudF9pZCI6IkNQaGlsbGlwc1Rlc3QiLCJzY29wZSI6IlB1YmxpY1dlYkFwaSJ9.B38z98IffaBiwfZM5dQMagUcazVj-ypfajXn0zdwRMeNWBnd9q2vKHuCvVLRMV5SIYtQn4M7aSi-1ZpJ6e-ruX4XmJXsKvYmv_x9jaGPipcVwfrqOA7qbbRG2wTJzdnKkwqFgr7k3RVOtC3rf_HfffEVxa8ZyVpi94wP-ispkhWrH8c7Mwd5-B0HnOpM_3eyH920ME9UEMW6ZJRwpl3GzcoJOlpXf0k33ttJLPGC819xsVK0B947xxffo-ZaQHVwn9B9mLbN3PFU97Jhiiron9x9fKsw5coeC8XcBsNvI-bFaMFeMc3mFA-Mi_194xPQjDq9B87-ri5eWuIvHwUIwg
The resulting response will contain a collection of ProfileMinDtos that meet your search results. Here's an example response for our member search request:
{
- "TotalCount": 1,
- "TotalPages": 1,
- "CurrentPageNumber": 1,
- "PageSize": 20,
-
"Result": [
{
- "ProfileId": 2,
- "OrgInd": true,
- "Member": true,
- "Prospect": false,
- "Email": "",
- "ReportName": "Starfleet",
- "OrgName": "Starfleet",
- "Prefix": "",
- "FirstName": "",
- "LastName": "",
- "Title": "",
- "WorkPhone": "",
- "HomePhone": "",
- "CellPhone": "",
- "PhoneDefault": "Work",
- "Address1": "557 McReynolds Rd",
- "Address2": "",
- "City": "Sausalito",
- "State": "CA",
- "Zip": "94965",
- "MainRelatedProfileName": null,
- "MainRelatedProfileId": 0,
- "ProfileTypeId": 0,
- "Website": "",
- "DateChanged": "2018-03-14T15:00:46.543Z",
- "County": "",
- "Country": "",
- "MemberTypeIconColor": "Red"
- ]
Congratulations, you've now made your first requests to the Atlas API. For more information on your authorization options visit our API Authorization page and for a list of available resource routes, check out our API Resources page.