Configuratie
Voordat u aan de slag gaat met het maken van uw PHP-toepassing, moet u de app eerst verifiëren met Zoho. En om dit te doen, moeten er configuratieprocedures worden uitgevoerd. U kunt uw toepassing op twee manieren verifiëren:
- Een configuratiematrix doorgeven - en vervolgens ZCRMRestClient::initialize($configuration) aanroepen;
- De matrixoptie is alleen beschikbaar voor versie 1.1.0 en hoger.
- Eigenschappenbestanden gebruiken in de map met bronnen en vervolgens ZCRMRestClient::initialize() aanroepen;
Eigenschappenbestand
De gegevens van uw OAuth-client moeten aan de PHP SDK worden verstrekt als een eigenschappenbestand. In PHP SDK hebben we een configuratiebestand (oaut_configuration.properties) geplaatst. Plaats de respectievelijke waarden in dat bestand. U vindt dit bestand onder 'vendor/zohcrm/php-sdk/src/resources'.
Vul alleen de volgende sleutels in. Wijzig de waarde van 'accounts_url' op basis van uw domein (EU,CN). Standaardwaarde ingesteld als US-domein.
client_secret=
redirect_uri=
accounts_url=https://accounts.zoho.com
token_persistence_path=
- Alleen de hierboven weergegeven sleutels moeten worden ingevuld.
- 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 moet alleen op offline worden ingesteld omdat de online OAuth-client vanaf nu niet meer wordt ondersteund door de PHP SDK.
- persistence_handler_class is de implementatie van de ZohoOAuthPersistenceInterface ofwel ZohoOAuthPersistenceHandler.
- token_persistence_path is het pad om de OAuth-gerelateerde tokens in het bestand op te slaan. Als dit is ingesteld, is een database niet nodig voor persistentie. Persistentie vindt alleen plaats via een bestand.
Maak een bestand met de naam "ZCRMClientLibrary.log" op het systeem met uw clientapp en vermeld het absolute pad van het gemaakte bestand in configuration.properties voor de sleutel "applicationLogFilePath". U vindt dit bestand onder 'vendor/zohcrm/php-sdk/src/resources'. Met dit bestand worden de uitzonderingen geregistreerd die zijn opgetreden tijdens het gebruik van PHP SDK.
Vul alleen de volgende sleutel in
Wijzig de waarde van de volgende sleutel in true in het bestand configurations.properties als u API-aanroepen wilt uitvoeren voor een sandbox-account. De waarde is standaard false.
Als uw toepassing slechts één gebruikersverificatie nodig heeft, moet u de e-mail-ID van de gebruiker instellen in het configuratiebestand configurations.properties, zoals hieronder wordt aangegeven:
Als u met verificatie voor meerdere gebruikers wilt werken, moet u de e-mail-ID van de gebruiker instellen in de superglobale variabele '$_SERVER' van PHP, zoals hieronder wordt aangegeven:
U kunt ook de variabele $_SERVER gebruiken voor verificatie door één gebruiker, maar het wordt aanbevolen om de e-mail-ID in het bestand configuration.properties in te stellen.
Als u de e-mail van de gebruiker niet instelt als een superglobale variabele, wordt verwacht dat deze is ingesteld in het bestand configuration.properties. Als het e-mailadres van de gebruiker niet in een van deze twee is ingesteld, zal een uitzondering optreden in PHP SDK.
Configuratiematrix
U kunt de configuratiewaarden nu als argument doorgeven via een PHP-matrix (sleutelwaardepaar) wanneer u de functie ZCRMRestclient::initialize() aanroept. Hieronder vindt u een lijst met sleutels die in de matrix moeten worden opgenomen.
| Verplichte sleutels | Optionele sleutels |
|---|---|
| client_id | applicationLogFilePath |
| client_secret | sandbox |
| redirect_uri | apiBaseUrl |
| currentUserEmail | apiVersion |
| client_secret | access_type |
| accounts_url | |
| persistence_handler_class | |
| token_persistence_path |
Let op:
- De sleutel "currentUserEmail" moet worden opgegeven als deze niet globaal aanwezig is (bestaande functionaliteit).
- Als de optionele sleutels niet zijn opgegeven, worden de standaardwaarden automatisch toegewezen.
- De 'apiBaseUrl' en 'accounts_url' zijn verplicht als de gebruiker zich niet in het "com"-domein bevindt.
Hieronder staat een voorbeeld van een PHP-matrix met de verplichte sleutels.
Hieronder staat een voorbeeld van een PHP-matrix met alle sleutels.