-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathintegrations.html
89 lines (50 loc) · 8.63 KB
/
integrations.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Loopline Systems API</title><link rel="stylesheet" href="css/bootstrap-3.1.1.min.css"><link rel="stylesheet" href="css/font-awesome-4.0.3.min.css"><link rel="stylesheet" href="css/styles.css"><link rel="shortcut icon" href="http://cdn.loopline-systems.com/favicon.ico"><link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://cdn.loopline-systems.com/lls-logo-144.png"></head><body><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container"><div class="row"><div class="col-md-3"><nav class="static"><a href="index.html"><img src="img/lls-logo.png" class="logo"></a><div id="static-pages" class="list-group"><a href="index.html" class="list-group-item heading">Loopline Systems API</a><a href="chrome_postman.html" class="list-group-item">Sandboxing with Postman</a><a href="error_responses.html" class="list-group-item">Error Responses</a><a href="integrations.html" class="list-group-item">Integrations</a><a href="index.html" class="list-group-item">REST API</a></div></nav><nav id="nav" class="hidden-sm hidden-xs affix nav dynamic"></nav></div><div id="content" class="col-md-8"><div><header><div class="page-header"><h1 id="top">Loopline Systems API Documentation</h1></div></header></div><h1>Integrations</h1>
<p>Loopline provides the following integrations to synchronize users from other software.</p>
<h2>BambooHr Integration</h2>
<p><img alt="Loopline-BambooHR Integration" src="img/bamboohr-logo.jpg"/></p>
<p>For a complete guide to BambooHR Integration please visit this page: <a href="http://www.loopline-systems.com/en/integrations/bamboohr">Setting up integration with BambooHR</a></p>
<h2>Microsoft Azure Active Directory Integration</h2>
<p><img alt="Loopline-Atoss Integration" src="img/azure-logo.png"/></p>
<ol><li>Sign in to the Azure portal.</li><li>Select Active Directory service.</li><li>Select your desired directory.</li><li>Go to the APPLICATIONS tab.</li><li>Add a new application and select "Add an application my organization is developing" when prompted.</li><li>Set the name "Loopline Systems", and select the type "WEB APPLICATION AND/OR WEB APIWeb application and/or web API".</li><li>Put "http://loopline-systems.com" as both "SIGN-ON URL" and "APP ID URI".</li><li>Inside the created application, go to "CONFIGURE".</li><li>Copy the "Cleint ID" of the app and use it as "Client ID" integration parameter.</li><li>Generate a new key, and use the key as "Client Secret" integration parameter.</li><li>Give "Read directory data" permissions to this application.</li><li>You can use your Azure domain (*.onmicrosoft.com) as your "Tenant ID" or to see you actual Tenant ID click on
"View Endpoints" and use the GUID part of the URLs as your "Tenant ID".</li></ol>
<p>You may also follow this guide: <a href="https://azure.microsoft.com/en-us/documentation/articles/active-directory-integrating-applications/#adding-an-application">Integrating Applications with Azure Active Directory</a>,
or <a href="https://msdn.microsoft.com/office/office365/HowTo/add-common-consent-manually#bk_RegisterServerApp">"Register your web server app with the Azure Management Portal"</a>. </p>
<h2>Microsoft Office 365 Integration</h2>
<p><img alt="Loopline-Atoss Integration" src="img/office365-logo.png"/></p>
<p>You need an Azure subscription to access Office 365 Active Directory API.</p>
<p>The setup is similar to Microsoft Azure Active Directory Integration via Azure portal, as described above.</p>
<p>You may also follow the <a href="https://msdn.microsoft.com/office/office365/HowTo/add-common-consent-manually#bk_RegisterServerApp">"Register your web server app with the Azure Management Portal"</a> from this official guide
<a href="https://msdn.microsoft.com/en-us/office/office365/howto/add-common-consent-manually">Manually register your app with Azure AD so it can access Office 365 APIs</a>.</p>
<h2>Microsoft Windows Active Directory (LDAP) Integration</h2>
<p><img alt="Loopline-Active Directory (LDAP) Integration" src="img/activedirectory-logo.jpg"/></p>
<h3>Parameters:</h3>
<ol><li>Host: Host name or IP address of your Active Directory services server.
It is also possible to use a full LDAP URI of the form <code>ldap://hostname:port</code> or <code>ldaps://hostname:port</code> for SSL encryption. </li><li>Port: Default port is 389.</li><li>Username: Account name used to logon (RDN/Username/UserPrincipalName/SAM-Account-Name) </li><li>Password: Password used to logon.</li><li>Base DN: Base DN to fetch users from, For example: <code>DC=yourdomain,DC=com</code></li><li>Filter: It is possible to specify a filter to limit the objects that are fetched from the AD. The default filter is <code>(&(objectCategory=person)(objectClass=user))</code>.
See <a href="http://www.faqs.org/rfcs/rfc4515.html">RFC4515</a> for more information on LDAP filters.</li></ol>
<h2>Atoss Integration</h2>
<p><img alt="Loopline-Atoss Integration" src="img/atoss-logo.jpg"/></p>
<p>Atoss integrations works by importing the users list from a CSV file exported by Atoss, via a FTP connection.</p>
<h3>This is how it works:</h3>
<pre><code>1. Export users from Atoss into a CSV file.
2. Put the file on a FTP server.
3. Setup Atoss integration in Loopline.</code></pre>
<p>Note: If the creation of the CSV file gets automated, Loopline can also run automatic import every 2 hours.</p>
<p>The format of the CSV file is described in the following section: CSV Upload.</p>
<h3>Configure FTP connection:</h3>
<p><img alt="Loopline-Atoss Integration" src="img/atoss-config.png"/></p>
<h2>CSV Upload</h2>
<p><img alt="Loopline-CSV Integration" src="img/csv-logo.jpg"/></p>
<p>You can import your users via uploading a <code>.csv</code> (comma spearated) file.
The format of the CSV file should be as follow:</p>
<p><code>user id, first name, last name, email, position, supervisor, department, deactivated</code></p>
<ul><li>User Identity / Id (required): Give each user a unique identifer such as their ID Number or email address</li><li>First Name (required)</li><li>Last Name (required)</li><li>Email Address (required)</li><li>Position (optional)</li><li>Supervisor Reference (optional): This can be the User ID or Email Address of the supervisor</li><li>Department Name (optional): This field is not currently imported but it will be supported in future.</li><li>Deactivated (optional): If this is set to either of Yes/True/1 the user will be deactivated</li></ul>
<h3>Sample:</h3>
<ul><li>"123-abc“,"Christian“,"Kaller","christian.kaller@loopline-systems.com“,“Managing Director","", "Management“, "false"</li><li>"456-xyz","Marco","Roßdeutscher","marco.rossdeutscher@loopline-systems.com","CTO","christian.kaller@loopline-systems.com"</li><li>"789-lmn","Amir","Rahimi","amir.rahimi@loopline-systems.com","Developer","456-xyz", "IT", "true"</li></ul>
<p>In the sample above:</p>
<ul><li>First line indicates a person with no supervisor.</li><li>Second line has a supervisor referenced by email address. It ommits all the optional columns which is fine.</li><li>Third line has a supervisor referenced by user id. This user is deactivated.</li></ul>
<h3>Options:</h3>
<p>It is possible to set CSV parsing parameters in the <code>config</code> section:</p>
<ul><li>Delimiter: Default delimiter character is <code>,</code> (comma) - (one character only)</li><li>Enclosure: Default encolsure character is <code>"</code> (double quotes) - (one character only)</li><li>Escape: Default escape character is <code>\</code> (backslash) - (one character only)</li><li>Ignore Lines: Number of lines to ignore from the begining of the file. Useful to skip header rows. Default is zero.</li></ul><hr /></div></div></div><p id="footer" style="text-align: center;" class="text-muted">Generated with <a href="https://apiblueprint.org/" target="_blank" class="aglio">API Blueprint</a> and <a href="https://github.com/danielgtaylor/aglio" target="_blank" class="aglio">Aglio</a> and <a href="http://www.loopline-systems.com" target="_blank" class="aglio">© 2020 made with <span no-class="❤" class="heart">❤︎</span> in berlin</a></p></body><script src="js/jquery-1.11.0.min.js"></script><script src="js/bootstrap-3.1.1.min.js"></script><script src="js/api-doc.js"></script><script>(function() {
$('table').addClass('table');
}).call(this);
</script></html>