Refresh URL

It helps in refreshing the access token once it has been expired. This prevents the user from repeating the long winding process of generating the grant token and carrying it generating the access token.

Possible Locations

• OAuth2

Child Elements

• Description
• Operation   required

Attributes

Example

In the trips resource, we use the oauth2 flow for authentication. So you have to add the refresh url to the authentication schema as shown here.

    

        
copy
        

            

        
    
    

         
<refresh-url path="https://accounts.travel_bureau.com/oauth/v2/token">
	<operation method="post" name="Refresh Access Token" category="action">
		<description>Access tokens expire after an hour of generation. To generate a new access token, use the refresh token you generated earlier.</description>
		<argument name="refresh_token" location="param">
			<content>
				<encode type="text/plain" />
				<structure>
					<property type="string" values="authorization_code"/>
				</structure>
			</content>
		</argument>
		<argument name="client_id" location="param">
			<description>Specify client-id obtained from the connected app.</description>
			<content>
				<encode type="text/plain" />
				<structure>
					<property type="string"/>
				</structure>
			</content>
		</argument>
		<argument name="client_secret" location="param">
			<description>Specify client-secret obtained from the connected app.</description>
			<content>
				<encode type="text/plain" />
				<structure>
					<property type="string"/>
				</structure>
			</content>
		</argument>
		<argument name="grant_type" location="param">
			<content>
				<encode type="text/plain" />
				<structure>
					<property type="string" values="refresh_token"/>
				</structure>
			</content>
		</argument>
		<response status="200">
			<content>
				<encode type="application/json" />
				<structure>
					<property name="access_token" type="string">
						<description>Access token to access ZohoCRM APIs</description>
					</property>
					<property name="expires_in" type="string" values="3600">
						<description>Time in seconds after which the access token expires</description>
					</property>
					<property name="api_domain" type="string">
						<description>Domain name of the API. Use this domain in your requests to make API calls to Zoho CRM.</description>
					</property>
					<property name="token_type" type="string" values="Bearer">
						<description>Type of token obtained. "Bearer" indicates this is an access token.</description>
					</property>
				</structure>
			</content>
		</response>
	</operation>
</refresh-url>