Skip to content

batnom/Generic-API-Client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Generic-API-Client

Sample cURL commands, Python code and PHP code for connecting to MyDesktop's Generic API

Only approved integration partners can access this API. To find out more, please email api@mydesktop.com.au.

Changes to the API are published on Twitter - https://twitter.com/MyDesktopAPI

Authentication Flow

Once you've become an approved integration partner, MyDesktop will supply you with a unique API Key. Every request must include a query string parameter api_key with your API Key. This is how we identify you as the partner accessing the API.

The MyDesktop user will also need to allow you API access to their MyDesktop database. They will supply you with a unique Access Token. This token never changes for that user, unless they revoke and re-create the token.

Now, you can use the Access Token to access the user's data. For example, you would call the /contacts endpoint, using the Access Token as the HTTP Basic Authentication username.

We recommend building logic in to your application to handle a 401 error.

Date/Time Format

Generally, the API returns the following format for Date objects:

YYYY-MM-DD

e.g. 2016-04-28

and the following format for DateTime objects:

YYYY-MM-DDThh:mm:ss

e.g. 2016-04-28T14:49:05

When sending date/datetime data to the API, you have the option to submit in these formats:

Date: YYYY-MM-DD

DateTime: YYYY-MM-DDThh:mm:ss, YYYY-MM-DD hh:mm:ss

Please note that all times are 24-hour.

About

A sample test client for the generic MyDesktop API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published