API V2.0: Difference between revisions

Jump to navigation Jump to search
No edit summary
Line 30: Line 30:


The ''token'' returned in step 2 can be included as a header to authenticate calls to other API endpoints.
The ''token'' returned in step 2 can be included as a header to authenticate calls to other API endpoints.
  Note: ''tokens'' expire after 24 hours.
 
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span> ''tokens'' expire after 24 hours.


'''Step 4: Use the refresh token to generate new tokens'''
'''Step 4: Use the refresh token to generate new tokens'''
Line 36: Line 37:
As ''tokens'' expire after 24 hours, you will need to use the ''refresh token'' with GET /authentication/token to get new tokens when old ones expire.
As ''tokens'' expire after 24 hours, you will need to use the ''refresh token'' with GET /authentication/token to get new tokens when old ones expire.


  Note: ''Refresh tokens'' do not expire so long as they have been used within the past 30 days.
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span> ''Refresh tokens'' do not expire so long as they have been used within the past 30 days.


= Invite codes =
= Invite codes =
Line 197: Line 198:


Each response item will contain a "success" boolean field. Success will be false if there were any errors in processing the item.
Each response item will contain a "success" boolean field. Success will be false if there were any errors in processing the item.
  Note: Success being false does not necessarily mean that nothing has changed.  
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> Success being false does not necessarily mean that nothing has changed.  
  E.g. if a valid booking with an invalid info item is posted, the booking will be created but the info item will not. Success will be false in this case because there was an error.
  E.g. if a valid booking with an invalid info item is posted, the booking will be created but the info item will not. Success will be false in this case because there was an error.