Atlas API Support

The Atlas API is in place to help developers leverage even more the powerful capabilities of Atlas and develop additional functionality, specifically tailored for their business. 

If you are interested in using our API, reach out to your commercial contact and they'll help you in making this available to you.

• The Atlas extensibility platform
• APEX working for you
• What functions might you extend
• How do we handle our API related queries
• APEX Commercial model
• FAQ
• How to setup a GitHub account

The Atlas extensibility platform

APEX working for you

The Atlas API can be consumed from

• Power Automate
• .NET Applications
• SharePoint/Teams SPFx Applications
• Powershell

Relevant example use of the API and documentation will be provided via GitHub.

Example of Atlas AOI (Provisioning End Point) (see image below):

• Create a new Atlas workspace based upon existing Atlas workspace templates
  • Apply workspace naming policies and URLs
  • Apply metadata tags
  • Add member
  • Set as Public/Private
  • Configure Add It
  • Add to Atlas navigation

What functions might you extend

BID management

• Atlas workspaces with MS Team automatically created for each bid directly out of CRM
• Automatically add bid documents in structured channels or folders
• Workspace links back to CRM for slick access between apps

Project Management

• Atlas workspaces with MS Team automatically created each project from a custom form or ERP/Billing system
• Automatically add project documents in structured channels or folders
• Workspace links back to ERP/Billing system for slick access between apps

Client Portals

• Atlas workspaces with MS Team automatically created out of PMS or Outlook
• All client documents in structured channels or folders
• Workspace links to other tools for slick access between apps

Legal Matters

• Atlas workspaces with MS Team automatically created for each matter directly our of PMS or Outlook
• All matter documents in structured channels or folders (e.g. Precedent H structure)
• Workspace links to Case Management tools for slick access between apps 

How do we handle our API related queries

All API related requests are handled in our ClearPeople Github repositories. 

In this platform your developers can create their GitHub account and they can collaborate with our developer team. Simply put, we ensure we have techies talk techy language to each other!

All our support activity normally go through Zendesk but for API related topics our support team will always advice you to connect via GitHub and they will NOT act on any ticket raised via Zendesk. 

Also keep in mind that there's no SLA on API related queries but we will try to connect and provide feedback in the GitHub repositories in a timely matter. 

APEX Commercial model

FREEMIUM	DEVELOPER SUPPORT
Access to API documentation (reach out to your CSA) No cost to existing Atlas subscribers	Access to GitHub platform (Limited to 1 Developer) Bi-Weekly Atlas Developer review Access to the Atlas developer community
Pricing: Included within standard Atlas license	Pricing: £3000 per annum
Recommended if: You have a dedicated in-house/third-party dev team that is very familiar with M365 extensibility and considered experts in the matter​ You are not planning to use the API for business-critical workloads	Recommended if: You have a dedicated in-house/third-party dev team that is familiar with M365 extensibility and considered experienced in the matter​ You are planning to use the API for business-critical workloads
Note: This is purely self-serviced and it doesn’t include any support from ClearPeople​ It doesn’t provide access to any forums or communications channel with other developers	Note: Community driven experience with no SLA commitments​ This is not a consulting service and ClearPeople reserves the right to respond only to queries that are aligned with the design and intended use boundaries of Atlas (Software Boundaries and Limits of Atlas – Atlas by ClearPeople (zendesk.com))

FAQ

Q: What if I don’t have a dedicated dev team for Atlas extensibility? Could you help us with that?​
A: Of course, we could introduce one of our preferred partners for Atlas extensibility.

Q: Do you provide consulting services to help with Atlas extensibility?
A: No. But feel free to reach out if you need specific training sessions or adoption services to help your team to speed up with Atlas.

Q: Does APEX support service cover for integrations with external systems other than Atlas?​
A: While APEX main purpose will be to enable your team to integrate line of business applications with Atlas we cannot provide any support on those third-party systems, so the scope of support will be always limited to issues sourced within the APEX API.

Q: Can I use APEX for free?​
A: You can access the API documentation for free but if you want to effectively start using the API integration you have to move into Developer Support.​

How to setup a GitHub account

Go to our GitHub repository https://github.com/ClearPeopleLtd

Use the sign up button at the top right of your screen

Follow the sign up guidance and create your account

You'll receive an email with a code to confirm your email address is valid

You're all set and you can start using GitHub and follow our organization