Skydrop API Documentation
These documents cover the Skydrop api service. Skydrop exposes functionality to Skydrop controllers using restful calls with oath2 authentication protocols.
Getting Started
Here is a quick outline how to get up and going with Skydrop's API:
Quick Steps Overview
- Create a Skydrop login @ Skydrop Web Client then contact api@skydrop.com to initiate a discussion on granting API access.
- After API access has been granted, login to Skydrop's API service @ Skydrop API
- Once logged in, create a new application
- Use the new application settings to access the Skydrop API
Register for a new Skydrop login
Register for a new Skydrop account @ Skydrop Web Client
It's simple, and only requires your name, email, and a password.
Create new application
Login to the Skydrop API service @ Skydrop API
Once signed in to Skydrop's API service it's easy to create a new application. This represents the application you will use to access the Skydrop API.
First, click on the "+" sign at the upper left part of the screen. This will take you a new application form as shown below:
Next, fill out the form by naming your application, describing it, and most importantly filling out the URI that will be returned to upon completion of the authorization process.
As mentioned, all authentication is handled through the OAUTH 2 standard. After creating a new application you will be assigned unique ids that you can use to authenticate against the Skydrop API. Below is a screen shot:
Authorize from your application
First, direct your user to https://api.skydrop.com/oauth/authorize using a GET request using a browser or mobile web view:
Param | Required | Description |
---|---|---|
response_type |
true |
Whether the endpoint returns an authorization code. For web applications, a value of code should be used. |
client_id |
true |
The authorization code as shown on application settings |
redirect_uri |
true |
An HTTPS URI or custom URL scheme where the response will be redirected. Must be registered when you created a new application |
User Experience
Your users will be forwarded to the Skydrop api authorize form:
At this point they need to use their Skydrop account credentials. After a successful login they will be taken to the Skydrop consent page as follows:
Once the user gives consent, the redirect_uri you provided in your applications settings will be called with the newly created grant code. You'll use this to get a token.
Getting the Access Token
Once your application has completed the above section and been given an authorization code, it’ll now need to exchange the authorization code for an access token.
Access Token: The access token is what’s needed to sign your API requests to the Skydrop API. You’re almost done!
To get the access_token, you’ll need to make a POST request to https://api.skydrop.com/oauth/token with the following parameters:
Param | Required | Description |
---|---|---|
grant_type |
true |
Must be "authorization_code" |
code |
true |
The authorization code as shown on application settings |
client_id |
true |
client_id in application settings |
client_secret |
true |
client_secret gotten from Skydrop in application settings |
Request: The request must be over HTTPS and the parameters must be URL encoded.
Renewing the Access Token
The token will expire and will need to be renewed.
Access Token: The access token is what’s needed to sign your API requests to the Skydrop API. You’re almost done!
To get the access_token, you’ll need to make a POST request to https://api.skydrop.com/oauth/token with the following parameters:
Param | Required | Description |
---|---|---|
grant_type |
true |
Must be "refresh_token" |
refresh_token |
true |
The refresh token when you received your initial token |
client_id |
true |
client_id in application settings |
client_secret |
true |
client_secret gotten from Skydrop in application settings |
Request: The request must be over HTTPS and the parameters must be URL encoded.
Make some calls
Now you have full access to the Skydrop API calls documented under the other sections below. All calls require a public controller id. Use the "User Methods" to acquire your public controller ids. All references to "[api_url]" should be replaced with http://api.skydrop.com.