Configuratie

Voordat u aan de slag gaat met het maken van uw C#-toepassing, moet u de app eerst verifiëren met Zoho. En om dit te doen, moeten er configuratieprocedures worden uitgevoerd. In principe moeten de gegevens van de OAuth-client worden opgegeven als een sectie in het bestand app.config.

Voeg een sectie oauth_configuration toe aan het bestand app.config en zorg ervoor dat de sectie het kenmerktype 'ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK' heeft. Bijvoorbeeld:

• client_id, client_secret en redirect_uri zijn de configuraties van uw OAuth-client die u krijgt nadat u uw Zoho-client hebt geregistreerd.
• access_type wordt standaard ingesteld op offline. Toegangs- en vernieuwingstokens worden alleen ontvangen als deze offline zijn.
• iamUrl - URL die moet worden gebruikt bij het aanroepen van OAuth-accounts. Deze wordt gebruikt om het domein van de gebruiker aan te duiden. De URL kan zijn:
  • https://accounts.zoho.com voor de VS.
  • https://accounts.zoho.eu voor Europese landen.
  • https://accounts.zoho.com.cn voor China.
• persistence_handler_class is uw implementatie van de IZohoPersistenceHandler-interface, die verwerkingsmethoden heeft om OAuth-gegevens op te slaan. Dit wordt in het volgende gedeelte besproken.
  Bijvoorbeeld: persistence_handler_class=ZCRMSDK.OAuth.ClientApp.ZohoOAuthFilePersistence, ZCRMSDK (of) ZCRMSDK.OAuth.ClientApp.ZohoOAuthDBPersistence, ZCRMSDK (of) uw eigen persistentiehandlerklasse.
• Als u de voorkeur geeft aan onze databasepersistentie (ZohoOAuthDBPersistence.cs), moet u de sleutels mysql_username en mysql_password opgeven voor mysql-connectiviteit.
  • Standaard geldt het volgende: mysql_username = "root", mysql_password = "", mysql_database = "zohooauth", mysql_server = "localhost" en mysql_port = "3306".
  • De tokens worden automatisch gegenereerd en in de databasetabel geplaatst (dit wordt uitgelegd in de sectie ZohoOauthDBPersistence) zodra het verificatieproces is voltooid.
• oauth_tokens_file_path is vereist als File Persistence van de SDK wordt gebruikt als persistentiehandler. Dit is het pad naar het bestand waarin de tokens van de gebruiker worden opgeslagen.

Behalve de bovenstaande OAuth-configuraties biedt de SDK ook opties om bepaalde HTTP-aanvraagkenmerken te negeren. Deze configuraties moeten worden geleverd via een sectie met de naam zcrm_configuration in het bestand app.config.

Het type sectie moet 'ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK' zijn.

De volgende configuraties worden ondersteund in de sectie zcrm_configuration:

• apiBaseUrl - URL die moet worden gebruikt bij het aanroepen van een API. Deze wordt gebruikt om het domein van de gebruiker aan te duiden. De URL kan zijn:
  • https://www.zohoapis.com
  • https://www.zohoapis.eu
  • https://www.zohoapis.com.cn
• PhotoUrl – URL voor de afbeelding die de record vertegenwoordigt. Het domein kan verschillen op basis van de apiBaseUrl. De URL kan zijn:
  • https://profile.zoho.com/api/v1/user/self/photo
  • https://profile.zoho.eu/api/v1/user/self/photo
  • https://profile.zoho.com.cn/api/v1/user/self/photo
• apiVersion is "v2".
• timeOut – Geeft de time-out van de aanvraag weer in milliseconden. Laat dit veld leeg als u het niet nodig hebt.
• minLogLevel – Geeft het minimale logboekniveau voor het loggen van SDK weer. De ondersteunde waarden zijn ALL, INFO, WARNING, ERROR en OFF. Het standaard minimale logboekniveau is WARNING.
• logFilePath – Geeft het bestand weer waarin logboekgegevens kunnen worden opgeslagen door de SDK. Dit is optionele configuratie die kan worden weggelaten. Als dit wordt weggelaten, registreert de SDK de bewerking in de uitvoeringsmap van de toepassing onder de bestandsnaam LogFile.log. Alleen het pad van het bestand, zonder de bestandsnaam, is nodig voor het opslaan van de logboeken.
• currentUserEmail – In geval van één gebruiker kan deze configuratie worden ingesteld.
• domainSuffix – Optionele configuratie. Biedt support voor multi-DC. Bijvoorbeeld com, eu of cn.