Roep principal-list aan met een filter:
Laatst bijgewerkt op
6 jan. 2022
|
Ook van toepassing op Adobe Connect 9
Leer de belangrijkste concepten en kom meer te weten over de basisprincipes om met Adobe Connect-webservice-API's aan de slag te gaan.
Als u met Adobe Connect-webservices aan de slag wilt gaan, moet u drie belangrijke concepten begrijpen:
Principals, (gebruikers en groepen)
SCO's (Shareable Content Objects), deze vertegenwoordigen vergaderingen, cursussen en bijna alle inhoud die op Adobe Connect kan worden gemaakt. SCO's (uitgesproken als sko, wat rijmt op snow) zijn compatibel met de industriestandaard SCORM-specificatie (Shareable Content Object Reference Model) en kunnen worden gebruikt met een Learning Management System (LMS).
Machtigingen, die bepalen hoe principals op objecten kunnen reageren
In dit hoofdstuk worden de basistaken beschreven die u met webservices kunt uitvoeren, ongeacht voor welke Adobe Connect-toepassingen u een licentie hebt. Veel taken worden beschreven alsof u deze in een browser uitvoert. Als u een aanroep vanuit een toepassing wilt uitvoeren, vertaalt u de XML-aanvraag naar de taal waarin u werkt (voor een voorbeeld van hoe u dit in Java™ doet, kunt u XML-aanvragen verzenden raadplegen).
Een principal-id zoeken
Een principal is een gebruiker of groep die een gedefinieerde machtiging heeft om met een SCO op de server te communiceren. U kunt gebruikers en groepen voor uw organisatie maken en de machtigingen wijzigen.
Adobe Connect heeft ook ingebouwde groepen: Beheerders, Beperkte beheerders, Auteurs, Trainingsmanagers, Gebeurtenismanagers, Studenten, Gastheren van vergaderingen en Gastheren van seminars. U kunt gebruikers en groepen toevoegen aan ingebouwde groepen, maar u kunt de machtigingen van ingebouwde groepen niet wijzigen.
Opmerking:
De ingebouwde groepen die beschikbaar zijn, zijn afhankelijk van uw account.
Elke Adobe Connect-gebruiker en -groep heeft een principal-id. In sommige API-aanroepen wordt de principal-id eengroup-id of user-id genoemd om deze te onderscheiden van andere waarden. De waarde van de ID die een gebruiker of groep identificeert, is altijd hetzelfde, ongeacht de naam.
De principal-id van een gebruiker of groep ophalen
-
https://example.com/api/xml?action=principal-list&filter-name=jazz doe
U kunt het beste filter-name, filter-login of filter-email gebruiken voor een exacte overeenkomst. Wees voorzichtig met filter-like-name, aangezien het de serverprestaties kan beïnvloeden.
-
Parseer de principal-elementen in het antwoord voor de principal-id:
<principal principal-id="2006282569" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>jazz doe</name> <login>jazzdoe@example.com</login> <email>jazzdoe@newcompany.com</email> </principal>
De principal-id van de huidige gebruiker ophalen
-
Roep common-info aan nadat de gebruiker zich heeft aangemeld:
https://example.com/api/xml?action=common-info
-
Parseer de gebruikerselementen in het antwoord voor de user-id:
<user user-id="2007124930" type="user"> <name>jazz doe</name> <login>jazz@doe.com</login> </user>
De principal-id wordt hier de user-id genoemd, omdat het altijd een gebruiker vertegenwoordigt die voor Adobe Connect is geverifieerd. Een groep kan niet inloggen op de server. U kunt de waarde user-id doorgeven als een principal-id in andere acties.
Principals of gasten weergeven
Een principal met een type gebruiker is een geregistreerde Adobe Connect-gebruiker, terwijl een gebruiker met een typegast als gast een vergaderruimte betreedt. De server legt informatie vast over de gast en de gast krijgt een principal-id.
Alle principals op de server weergeven
-
Roep principal-list aan zonder parameters:
https://example.com/api/xml?action=principal-list
Deze aanroep retourneert alle Adobe Connect-gebruikers, dus wees voorbereid op een hoge response.
-
Parseer de principal-elementen in het antwoord voor de gewenste waarden:
<principal principal-id="2006282569" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>jazz doe</name> <login>jazzdoe@example.com</login> <email>jazzdoe@newcompany.com</email> </principal>
Alle gasten op de server weergeven
-
Roep report-bulk-users aan en filter op een type gast:
https://example.com/api/xml?action=report-bulk-users&filter-type=guest
-
Parseer de row-elementen in het antwoord:
<row principal-id="51157227"> <login>joy@acme.com</login> <name>joy@acme.com</name> <email>joy@acme.com</email> <type>guest</type> </row>
Alle gebruikers die rapporteren aan een specifieke manager weergeven
Wanneer u principal-info met een principal-id aanroept, toont het antwoord de principal. Als de principal een gebruiker is aan wie een manager is toegewezen in Adobe Connect, toont het antwoord ook gegevens over de manager van de principal in een manager-element:
<manager account-id="624520" disabled="" has-children="false" is-hidden="false" is-primary="false" principal-id="2006282569" type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name> <email>joy@example.com</email> <first-name>jazz</first-name> <last-name>doe</last-name> <x-2006293620>23456</x-2006293620> <x-2007017651>chicago</x-2007017651> </manager>
U kunt de principal-id van de manager met principal-list gebruiken om alle gebruikers weer te geven die aan de manager zijn toegewezen.
-
Roep principal-list aan en filter op manager-id:
https://example.com/api/xml?action=principal-list &filter-manager-id=2006282569
-
Parseer het antwoord voor de principal-elementen:
<principal principal-id="2006258745" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false" manager-id="2006282569"> <name>Pat Lee</name> <login>plee@mycompany.com</login> <email>plee@mycompany.com</email> </principal>
Gebruikers maken
U moet beheerdersrechten hebben om een nieuwe gebruiker te maken. Adobe raadt u aan een gebruiker te maken die behoort tot de beheerdersgroep voor uw toepassing om API-aanroepen uit te voeren waarvoor beheerdersrechten zijn vereist.
Een nieuwe gebruiker maken en een welkomst-e-mail verzenden
-
Meld u aan als beheerder in uw toepassing.
Zie Inloggen vanuit een toepassing voor verschillende manieren om in te loggen.
-
Roep principal-update aan met minimaal deze parameters:
https://example.com/api/xml?action=principal-update &first-name=jazz&last-name=doe&login=jazz99@doe.com&password=hello &type=user&send-email=true&has-children=0&email=jazz99@doe.com
Het type moet user zijn, has-children moet 0 of false zijn, send-email moet true zijn en email moet een geldig e-mailadres bevatten.
De server stuurt een welkomste-mail met aanmeldinformatie naar het e-mailadres van de gebruiker.
-
Parseer het principal-element in het antwoord voor de principal-id van de gebruiker:
<principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> <login>jammdoe@example.com</login> <ext-login>jammdoe@example.com</ext-login> <name>jamm doe</name> </principal>
Een nieuwe gebruiker maken zonder een e-mailadres als aanmeldings-ID te gebruiken
-
Ga in Adobe Connect Central naar Beheer > Gebruikers en groepen > Beleid voor aanmelding en wachtwoorden bewerken. Zorg ervoor dat E-mailadres gebruiken als aanmelding is ingesteld op Nee.
-
Meld u aan als beheerder in uw toepassing.
-
Roep principal-update aan om de nieuwe gebruiker te maken, waarbij u zowel de parameters login en email doorgeeft:
https://example.com/api/xml?action=principal-update&first-name=jazz &last-name=doe&login=jazz&email=jazzdoe@company.com &password=nothing&type=user&has-children=0
-
Parseer het antwoord voor de principal-id van de nieuwe gebruiker:
<principal type="user" principal-id="2007184341" has-children="0" account-id="624520"> <login>jazzdoe@example.com</login> <ext-login>jazzdoe@example.com</ext-login> <name>jazz doe</name> </principal>
In het antwoord heeft ext-login standaard dezelfde waarde als login totdat de gebruiker inlogt met externe verificatie (zie Inloggen met HTTP-headerverificatie).
Gebruikers bijwerken
Nadat u gebruikers hebt gemaakt, moet u hun informatie vaak bijwerken. U kunt standaardvelden bijwerken die Adobe Connect voor gebruikers definieert door principal-update aan te roepen met de principal-id van de gebruiker. De standaardvelden omvatten email, login, first-name en last-name.
Als u aangepaste velden voor de principal hebt gedefinieerd, gebruikt u acl-field-update om deze bij te werken.
U hebt beheerdersrechten nodig om gebruikers bij te werken, dus u moet uzelf eerst aanmelden als gebruiker in uw toepassing in de beheerdersgroep. U kunt niet inloggen als gebruiker en vervolgens de gebruiker zijn of haar eigen profiel laten bijwerken.
Standaard gebruikersgegevens bijwerken
-
Meld u aan als beheerder.
-
Roep principal-list aan met een filter om de principal-id van de gebruiker op te halen (zie Een principal-id zoeken).
-
Roep principal-update aan om de gebruiker bij te werken:
https://example.com/api/xml?action=principal-update &principal-id=2006282569&email=jazzdoe@newcompany.com
-
Parseer het antwoord voor een statuscode van ok.
Aangepaste veldwaarden bijwerken voor een gebruiker
-
Meld u aan als beheerder.
-
Roep custom-fields aan om de field-id van het aangepaste veld op te halen:
https://example.com/api/xml?action=custom-fields
-
Haal de principal-id, sco-id of account-id op die u wilt bijwerken.
Deze waarde is de acl-id die u doorgeeft aan acl-field-update.
-
Roep acl-field-update aan om de waarde van het aangepaste veld bij te werken:
https://example.com/api/xml?action=acl-field-update&field-id=x-2007396975&acl-id=2006258745&value=44444
Aangepaste velden maken
Aangepaste velden zijn aanvullende gegevensvelden die u definieert. U kunt maximaal acht aangepaste velden op een principal of SCO definiëren met custom-field-update.
Nadat u het aangepaste veld hebt gedefinieerd, kunt u standaard de waarde ervan instellen door de waarde in Adobe Connect Central te bewerken of door custom-field-update aan te roepen.
Als u wilt aangeven dat de waarde alleen kan worden bijgewerkt via de API, roept u custom-field-update aan met de parameter object-type=object-type-read-only.
Een aangepast veld definiëren en instellen op een gebruiker
-
Maak eerst het veld met custom-field-update:
https://example.com/api/xml?action=custom-field-update &object-type=object-type-principal&permission-id=manage &account-id=624520&name=Location&comments=adobe%20location &field-type=text&is-required=true&is-primary=false&display-seq=9
Het veld Naam definieert de veldnaam zoals uw toepassing deze weergeeft. Gebruik dus de juiste spelling en hoofdletters. Het aangepaste veld in dit voorbeeld is gedefinieerd voor alle Adobe Connect-principals.
-
Parseer het field-element in het antwoord voor de field-id:
<field field-id="2007184366" object-type="object-type-principal" display-seq="9" account-id="624520" is-primary="false" permission-id="manage" is-required="true" field-type="text"> <comments>test</comments> <name>Country</name> </field>
-
De principal-id van de gebruiker ophalen (zie Een principal-id zoeken).
-
Roep acl-field-update aan om de waarde van het veld in te stellen, waarbij u een field-id, de principal-id van de gebruiker als de acl-id en een waarde doorgeeft:
https://example.com/api/xml?action=acl-field-update &acl-id=2006258745&field-id=2007017474&value=San%20Francisco
-
Parseer het antwoord voor een statuscode van ok.
Groepen maken
Als u gebruikers aan groepen wilt toevoegen, moet u principal-update aanroepen als de beheerder van uw toepassing.
Een gebruiker aan een groep toevoegen
-
Meld u aan als beheerder van uw toepassing.
-
(Optioneel) Als de gebruiker nog niet bestaat, maakt u de gebruiker met principal-update.
https://example.com/api/xml?action=principal-update &first-name=jazzwayjazz&last-name=doe&login=jazz@doe.com &password=nothing&type=user&has-children=0
-
(Optioneel) Parseer het antwoord voor de principal-id van de nieuwe gebruiker.
-
Als de gebruiker al bestaat, roept u principal-list aan om de principal-id van de gebruiker op te halen:
https://example.com/api/xml?action=principal-list&filter-type=user
-
Parseer het antwoord voor de principal-id:
<principal principal-id="5611980" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>Joy Black</name> <login>joy@acme.com</login> <email>joy@acme.com</email> </principal>
-
Roep principal-list opnieuw aan om de principal-id van de groep op te halen:
https://example.com/api/xml?action=principal-list&filter-type=group
-
Roep group-membership-update aan met is-member=true om de gebruiker aan de groep toe te voegen:
https://example.com/api/xml?action=group-membership-update &group-id=4930296&principal-id=2006258745&is-member=true
De principal-id is de principal-id van de gebruiker.
De group-id is de principal-id van de groep.
De parameter is-member moet true zijn.
Controleren of een specifieke gebruiker in een groep zit
-
Roep principal-list aan met een group-id, filter-is-member en een filter dat de principal identificeert:
https://example.com/api/xml?action=principal-list&group-id=624523 &filter-is-member=true&filter-like-name=bob
-
Parseer voor een principal-element in het antwoord. Een geslaagd antwoord ziet er als volgt uit:
<principal-list> <principal principal-id="624660" account-id="624520" type="user" has-children="false" is-primary="false" is-hidden="false"> <name>Bill Jones</name> <login>bjones@acme.com</login> <email>bjones@acme.com</email> <is-member>true</is-member> </principal> </principal-list>
Als de gebruiker geen groepslid is, is het element principal-list leeg:
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <principal-list /> </results>
Controleren welke gebruikers in een groep zitten
-
Als u de principal-id van de groep wilt ophalen, roept u principal-list aan met filters:
https://example.com/api/xml?action=principal-list&filter-type=group &filter-name=developers
Met filter-type en filter-name zouprincipal-list een unieke overeenkomst moeten retourneren.
-
Parseer het antwoord voor de principal-id:
<principal principal-id="2007105030" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>developers</name> <login>developers</login> <is-member>false</is-member> </principal>
-
Roep principal-list opnieuw aan, met de principal-id als een group-id en filter-is-member=true:
https://example.com/api/xml?action=principal-list&group-id=2007105030 &filter-is-member=true
-
Parseer het antwoord voor de principal-elementen:
<principal principal-id="5698354" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>Bob Jones</name> <login>bobjones@acme.com</login> <is-member>true</is-member> </principal>
Alle groepen weergeven waartoe een gebruiker behoort
-
Roep principal-list aan met de principal-id van de gebruiker en filter-is-member=true:
https://example.com/api/xml?action=principal-list &principal-id=2006258745&filter-is-member=true
-
Parseer het antwoord voor de principal-elementen:
<principal principal-id="5698354" account-id="624520" type="group" has-children="true" is-primary="false" is-hidden="false"> <name>Bob Jones</name> <login>bobjones@acme.com</login> <is-member>true</is-member> </principal>
SCO's zoeken
Alle objecten op Adobe Connect zijn Shareable Content Objects, oftewel SCO's. Het woord Shareable komt van Learning Management Systems waarin inhoud wordt gecombineerd tot cursussen of studieprogramma's en tussen deze wordt verdeeld.
Op de server kan een SCO elk inhoudsobject zijn dat wordt gecombineerd met andere inhoudsobjecten in een cursus of studieprogramma. Cursussen, studieprogramma's, presentaties en andere soorten inhoud zijn SCO's. Vergaderingen, gebeurtenissen, mappen, structuren, koppelingen, grafische bestanden of andere objecten zijn ook SCO's.
Elke SCO heeft een unieke integer-id genaamd een sco-id. De sco-id is uniek voor de hele server. Op een door Adobe Connect gehost account is de sco-id uniek voor alle accounts.
Elke SCO heeft ook een type, zoals inhoud, cursus, vergadering. , enzovoort. U kunt de sco-id en het type waarden in het antwoord van sco-info of andere acties zien:
<sco account-id="624520" disabled="" display-seq="0" folder-id="2006258747" icon="producer" lang="en" max-retries="" sco-id="2006334909" source-sco-id="" type="content" version="1">
Kenmerken van SCO's
Wanneer u de XML-antwoorden van verschillende aanroepen bestudeert, ziet u meer kenmerken van SCO's:
De id van een SCO wordt een sco-id genoemd in sommige acties, maar kan ook folder-id, acl-id of een andere naam worden genoemd in andere acties. Het is dezelfde unieke ID.
Elke SCO is toegankelijk voor verschillende principals, zowel gebruikers als groepen. De specifieke principals die toegang hebben tot een SCO worden gedefinieerd in toegangsbeheerlijsten of ACL's.
Elke SCO heeft een unieke URL, met twee delen: een domeinnaam (bijvoorbeeld http://example.com) en een URL-pad (bijvoorbeeld /f2006123456/). U kunt deze samenvoegen om de volledige URL te vormen die toegang heeft tot de SCO.
Elke SCO heeft een navigatiepad dat beschrijft waar deze zich bevindt in de maphiërarchie.
Elke SCO heeft een machtiging gedefinieerd voor elke principal die er toegang toe heeft.
Sommige SCO's hebben beschrijvingsvelden, dit zijn tekenreeksen, die u informatie geven over de SCO.
Vaak moet u de ID van een SCO of informatie erover vinden. SCO's zijn gerangschikt in een specifieke maphiërarchie waar mappen een naam hebben die aangeeft of ze zich op het hoogste niveau bevinden, gedeelde inhoud of sjablonen bevatten of gebruikersinhoud en sjablonen bevatten.
Wanneer u sco-shortcuts aanroept, wordt een lijst met mappen geretourneerd. Houd er rekening mee dat mappen verschillende typen hebben:
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <shortcuts> <sco tree-id="624530" sco-id="2006258751" type="my-meeting-templates"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624529" sco-id="624529" type="meetings"> <domain-name>http://example.com</domain-name> </sco> <sco tree-id="624530" sco-id="624530" type="user-meetings"> <domain-name>http://example.com</domain-name> </sco> ... </shortcuts> </results>
De mappen die in dit voorbeeld worden weergegeven, zijn toevallig voor vergaderingen, maar mappen voor andere typen SCO's volgen een soortgelijk patroon. Elk maptype slaat als volgt bepaalde typen objecten op, met bepaalde toegangsmachtigingen:
inhoud, cursussen, vergaderingen, gebeurtenissen, seminars
Dit zijn gedeelde mappen, zoals Gedeelde vergaderingen, Gedeelde training, enzovoort. De Adobe Connect-beheerder heeft toegang tot deze map. De beheerder kan de machtiging Beheren toewijzen aan elke gebruiker, maar alleen leden van de ingebouwde groep die aan de map is gekoppeld, kunnen er nieuwe inhoud of vergaderingen in maken.
user-content, user-meetings, user-courses, user-events
Deze mappen bevatten elk een map voor elke gebruiker die er inhoud in kan maken (bijvoorbeeld één map voor elke gastheer van een vergadering of ontwikkelaar van trainingen).
my-courses, my-events, my-meetings, my-meeting-templates, my-content
Gebruikers maken hun eigen inhoud in deze mappen en beschikken over de machtiging Beheren voor de inhoud. Gastheren van vergaderingen maken bijvoorbeeld vergaderingen in hun map my-meetings folder en beschikken over de machtiging Beheren voor die vergaderingen.
shared-meeting-templates
Deze map bevindt zich in de map Gedeelde vergaderingen, bevat vergadersjablonen en neemt de machtigingen over van Gedeelde vergaderingen.
U kunt de inhoud van elke map weergeven om informatie over een specifieke SCO op te halen. Wanneer u naar een SCO moet zoeken maar geen sco-id hebt, bladert u door de mappen met sco-shortcuts en sco-expanded-contents. Gebruik geen sco-search, aangezien het alleen bepaalde typen SCO's retourneert.
Een SCO vinden wanneer u de sco-id niet kent
-
Roep sco-shortcuts aan om een lijst met hoofdmappen op Adobe Connect op te halen:
https://example.com/api/xml?action=sco-shortcuts
-
Parseer het antwoord voor eentype hoofdmap dat logischerwijs de SCO zou bevatten, bijvoorbeeld, my-courses voor een cursus die de gebruiker heeft gemaakt.
-
Parseer het resulterende element sco voor een sco-id:
<sco tree-id="4930295" sco-id="2006258748" type="my-courses"> <domain-name>http://example.com</domain-name> </sco>
-
Voer een aanroep uit naar sco-expanded-contents om de inhoud van de map weer te geven, voeg indien mogelijk een exacte kopie van het filter toe:
https://example.com/api/xml?action=sco-expanded-contents &sco-id=2006258748&filter-name=All About Web Communities
U kunt kiezen uit verschillende filters:
Een exacte kopie van het filter op naam of url-path (bijvoorbeeld filter-name of filter-url-path), als u de naam of URL van de SCO weet.
Het datumfilter Later dan of Eerder dan (filter-gt-date of filter-lt-date) op date-begin, date-created of date-modified, als u een van die datums weet.
Een gedeeltelijk naamfilter (bijvoorbeeld filter-like-name), als u de exacte SCO-naam niet weet. Het gebruik van dit filter kan echter de systeemprestaties beïnvloeden.
-
Parseer het antwoord voor de sco-id:
<sco depth="1" sco-id="2006745671" folder-id="2006258748" type="folder" icon="folder" lang="en" source-sco-id="2006745669" display-seq="0" source-sco-type="14"> <name>A Day in the Life Resources</name> <url-path>/f28435879/</url-path> <date-created>2006-06-12T14:47:59.903-07:00</date-created> <date-modified>2006-06-12T14:47:59.903-07:00</date-modified> </sco>
Informatie opvragen over een SCO
-
Roep sco-info aan met de sco-id:
https://example.com/api/xml?action=sco-info&sco-id=2006745669
-
Parseer het antwoord voor name, url-path of een andere waarde:
<sco account-id="624520" disabled="" display-seq="0" folder-id="2006258748" icon="curriculum" lang="en" max-retries="" sco-id="2006745669" source-sco-id="" type="curriculum" version="0"> <date-begin>2006-06-12T14:45:00.000-07:00</date-begin> <date-created>2006-06-12T14:47:59.903-07:00</date-created> <date-modified>2006-06-12T14:47:59.903-07:00</date-modified> <name>A Day in the Life</name> <url-path>/day/</url-path> </sco>
De URL naar een SCO construeren
-
Roep sco-shortcuts aan:
https://example.com/api/xml?action=sco-shortcuts
-
Parseer het antwoord voor de waarde domain-name in een sco-element:
<sco tree-id="624530" sco-id="2006258750" type="my-meetings"> <domain-name>http://example.com</domain-name> </sco>
-
Roep sco-info aan met de sco-id:
https://example.com/api/xml?action=sco-info&sco-id=2006334909
-
Parseer het antwoord voor het url-path:
<sco account-id="624520" disabled="" display-seq="0" folder-id="2006258747" icon="producer" lang="en" max-retries="" sco-id="2006334909" source-sco-id="" type="content" version="1"> <date-created>2006-05-11T12:00:02.000-07:00</date-created> <date-modified>2006-05-16T15:22:25.703-07:00</date-modified> <name>Test Quiz</name> <url-path>/quiz/</url-path> <passing-score>10</passing-score> <duration>15100.0</duration> <section-count>6</section-count> </sco>
Het url-path heeft zowel een slash aan het begin als op het einde. U kunt het url-path overnemen van report-my-meetings, report-my-training of elke aanroep die het retourneert.
-
Voeg het url-path samen met de domain-name:
http://example.com/f2006258748/
Bestanden downloaden
U kunt zipbestanden van Adobe Connect naar de lokale computer van een gebruiker downloaden. Een zipbestand is een SCO. Als u het wilt downloaden, moet u een download-URL maken naar het zipbestand, dat er als volgt uitziet:
http://server-domain/url-path/output/url-path.zip?download=zip
Mogelijk weet u de domeinnaam van uw server al (bijvoorbeeld example.com). Zo niet, dan kunt u deze verkrijgen door sco-shortcuts aan te roepen.
Een zipbestand van de server downloaden
-
Roep sco-shortcuts aan:
https://example.com/api/xml?action=sco-shortcuts
-
Extraheer een domain-name-waarde uit het antwoord:
http://example.com
-
Roep sco-info aan met de sco-id van het zipbestand:
https://example.com/api/xml?action=sco-info&sco-id=2006258747
De SCO is het volledige zipbestand.
-
Parseer het antwoord voor het element url-path:
<sco account-id="624520" disabled="" display-seq="0" folder-id="624522" icon="folder" lang="en" max-retries="" sco-id="2006258747" source-sco-id="" type="folder" version="1"> <date-created>2006-04-18T10:21:47.020-07:00</date-created> <date-modified>2006-04-18T10:21:47.020-07:00</date-modified> <name>joy@acme.com</name> <url-path>/f124567890/</url-path> </sco>
-
Maak de download-URL, bijvoorbeeld:
https://example.com/quiz/output/quiz.zip?download=zip
Zorg dat u de slash aan het einde van de waarde url-path verwijdert voordat u .zip eraan toevoegt (zodat u een waarde hebt als /quiz.zip, niet /quiz/.zip).
Controleer de rechten
Machtigingen definiëren de manieren waarop een principal met een SCO kan communiceren.
Een machtigingstoewijzing, die aangeeft welke machtigingen een principal heeft voor een bepaalde SCO, wordt een toegangscontrolelijst of ACL genoemd. Een ACL bestaat uit drie stukken informatie:
De ID van een principal (een principal-id).
De ID van een SCO, account of principal waarop actie wordt ondernomen. In machtigingsaanroepen wordt deze een acl-id genoemd. In andere aanroepen wordt de ID wellicht een sco-id, account-id of principal-idgenoemd.
Een sleutelwoord dat het machtigingsniveau aangeeft van de principal, wat een van de geldige waarden is in permission-id.
De machtiging van een principal controleren op een SCO
-
Roep permissions-info aan met een acl-id en principal-id:
https://example.com/api/xml?action=permissions-info&acl-id=2006334909 &principal-id=2006258745
Voor controle op machtigingen op een SCO is de acl-id een sco-id. De acl-id kan ook een principal-id of account-id zijn.
-
Parseer het antwoord voor een permission-id:
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <permission acl-id="2007035246" permission-id="view" principal-id="2006258745" /> </results>
Als een principal geen expliciete machtiging heeft voor de SCO (met andere woorden, alspermission-id=""), zijn de machtigingen van de principal op het bovenliggende object van de SCO van toepassing.
De machtigingen van alle principals controleren op een SCO
-
Roep permissions-info aan met een acl-id, maar niet met een principal-id:
https://example.com/api/xml?action=permissions-info&acl-id=2006293572
-
Herhaal de principal-elementen en parseer ze voor permission-id-waarden:
<principal principal-id="2596608" is-primary="false" type="user" has-children="false" permission-id="view"> <name>Jay Arnold</name> <login>jay@example.com</login> </principal>
De geldige machtigingswaarden worden weergegeven in permission-id.
