Hoofdstukken in dit artikel:
Status van handtekeningaanvraag
Gebruik van handtekeningaanvragen
Live versus testmodus
Voordat je je app lanceert, kun je in de testmodus het aanvraagproces eerst uitproberen. Zo kun je nagaan of je workflow precies is georganiseerd zoals je wilt, en kun je beheermaatregelen instellen voor onverwacht gedrag voordat je live gaat.
Om aanvragen weer te geven die in de testmodus zijn gedaan, wijzig je de optie van Live in Test. Je kunt terugschakelen naar de live modus om gebeurtenissen van je live site weer te geven op het API-dashboard.
Inzichten
Het tabblad Inzichten geeft een algemeen overzicht van je API-gegevens. Op deze centrale plaats kun je zowel je API-aanvragen als de statussen en gebruiksgegevens van je handtekeningaanvragen bekijken. Deze gegevens worden visueel weergegeven in grafieken. Je kunt je tijdlijnweergave van deze gegevens aanpassen naar gegevenstype, datumbereik en foutstatus (API-foutverdeling, eindpunt of HTTP-status) via het vervolgkeuzemenu bovenaan de pagina. Je kunt ook logboeken controleren op app- en accountactiviteit.
Je kunt ook je quotagebruik (het aantal resterende handtekeningaanvragen) en factureringsgegevens bekijken op het tabblad Inzichten.
Status van handtekeningaanvraag
Je kunt document-ID's, statussen van handtekeningaanvragen, en datums en tijden van gebeurtenissen zien op het tabblad Status van handtekeningaanvraag De informatie op deze pagina kan met het vervolgkeuzemenu bovenaan de pagina worden gefilterd op datum en status van de handtekeningaanvraag.
Appcallbacks
Op het tabblad Appcallback kun je de interacties in je gebruikersinterface (UI) instellen en controleren, waardoor je een goed beeld krijgt van de gebruikersbetrokkenheid bij de geïntegreerde functionaliteit.
Appcallbacks worden geactiveerd wanneer een geprogrammeerde actie (ook wel een 'gebeurtenis' genoemd) plaatsvindt die is gekoppeld aan een bepaalde app. Op dit tabblad wordt alleen informatie over ingesloten aanvragen weergegeven.
Meer informatie over callbacks en hoe je ze instelt op je Dropbox API-dashboard.
Accountcallbacks
Op het tabblad Accountcallback kun je servergebeurtenissen instellen en controleren, voor een efficiëntere workflow en minimale vertragingstijd.
Accountcallbacks stellen je app op de hoogte wanneer er een gebeurtenis plaatsvindt waarbij je account betrokken is, door de payload van de gebeurtenis naar de URL van je accountcallback te sturen. Met andere woorden: wanneer alle gegevens in de gebeurtenis zijn gegenereerd. Je kunt je accountcallbacks filteren op datum en type gebeurtenis via de vervolgkeuzemenu's.
Je kunt de URL van je accountcallback instellen met de API-aanroep van je account, of deze handmatig instellen op de pagina Instellingen.
Meer informatie over callbacks en hoe je ze instelt op je Dropbox API-dashboard.
API-aanvragen
Het tabblad API-aanvragen biedt een beknopt overzicht van de functionaliteit van je verzonden aanvragen, zodat je eventuele foutmeldingen snel kunt achterhalen en oplossen.
API-aanvragen kunnen worden gefilterd op datum, HTTP-status, methode en eindpunt, via het vervolgkeuzemenu bovenaan de pagina.
De HTTP-codes geven de statussen weer van de interacties tussen je browser en de server. Met behulp van je API-dashboard kun je aanvragen filteren op HTTP-statuscode en vaststellen welke aanvragen aandacht nodig hebben en welke naar behoren werken.
Je kunt de volgende HTTP-statussen tegenkomen:
- De status Informational betekent dat de server de aanvraag nog niet heeft voltooid (codes 100-199).
- De status Success betekent dat de serveraanvraag zonder fouten is voltooid (codes 200-299).
- De status Redirectional betekent dat de aanvraag is ontvangen, maar vervolgens ergens anders naar is doorgestuurd (codes 300-399).
- De status Client error betekent dat de pagina niet kon worden bereikt. Dit is een fout van de kant van de website en treedt meestal op als de websitepagina niet bestaat (codes 400-499).
- De status Server error betekent dat er een geldige aanvraag is gedaan, maar dat de server die niet heeft kunnen voltooien zoals verwacht (codes 500-599).
Je kunt handtekeningaanvragen ook filteren op methode:
- GET wordt gebruikt om een bron op te halen of te lezen.
- POST wordt gebruikt om een nieuwe bron te maken.
- DELETE wordt gebruikt om de volledige bron te verwijderen.
- PUT wordt gebruikt om de volledige bron aan te passen.
- PATCH wordt gebruikt om een deel van de bron aan te passen.
Je filtert aanvragen als volgt op eindpunten:
- Maak eventuele andere aanvraagparameters die je nodig hebt voor deze weergave (datum, HTTP-status, methode).
- Klik op Eindpunt.
- Klik op Aangepast.
- Vink het vakje aan naast elk eindpunt dat van toepassing is.
- Klik op Toepassen.
De lijst met eindpunten is beschikbaar in het overzicht van handtekeningaanvragen.
Gebruik van handtekeningaanvragen
Handtekeningaanvragen kunnen worden gebruikt om te verwijzen naar aanvraagspecifieke gegevens, waaronder de namen en e-mailadressen van ondertekenaars, aangepaste velden, metagegevens, antwoordgegevens en tijdstempels met informatie over wanneer de aanvraag is gemaakt en voltooid. Je kunt gebruiksgegevens filteren op datum en client-ID.
Opmerking: informatie over hoe handtekeningaanvragen worden gebruikt, wordt ook visueel weergegeven als grafiek op de pagina Inzichten.
Apps en sleutels
Het tabblad Apps en sleutels leidt je door naar de pagina Instellingen, waar je je gekoppelde apps en API-sleutels kunt weergeven en beheren.
Meer informatie over het maken en beheren van meerdere API-sleutels.
CSV downloaden
Op het tabblad CSV downloaden staat de geschiedenis van de handtekeningaanvragen van je account binnen een aangepast datumbereik. Je kunt deze lijst exporteren naar een .csv- bestand.
Volg daarvoor deze stappen:
- Meld je aan bij Dropbox Sign.
- Klik op API.
- Klik op API-dashboard weergeven.
- Klik op CSV downloaden.
- Voer het gewenste datumbereik in voor je export.
- Klik op CSV downloaden.
Ga naar je Dropbox Sign API-dashboard om aan de slag te gaan.
Gerelateerde bronnen
- Voor meer informatie over de beschikbare functies en het gebruik van het API-dashboard kun je onze handleiding voor het API-dashboard raadplegen.
- Voor meer informatie over het instellen en uitvoeren van de Dropbox Sign API kun je onze API-snelstartgids raadplegen.
Als je vragen hebt of een probleem wilt melden, kun je hier een aanvraag indienen.
Opmerkingen
0 opmerkingen
Artikel is gesloten voor opmerkingen.