Slickplan v1 API Documentation
Latest commit 9f2a84c Nov 20, 2016 @pawelatomic pawelatomic date fix
Permalink
Failed to load latest commit information.
endpoints update Nov 20, 2016
sections API update 2016-09-12 Sep 13, 2016
.gitignore API update 2016-09-12 Sep 13, 2016
README.md date fix Nov 20, 2016

README.md

Slickplan API

This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.

Making Requests

The Base URL

All requests start with the https://slickplan.com/api/v1/ base URL.

  • All requests are done via SSL only.
  • All responses are in JSON.
  • The API expects all data to be UTF-8 encoded.

Authentication

In order to make authorized calls to Slickplan's API, your application must first obtain an OAuth access token. To register your app go to https://slickplan.com/api/register (to modify your existing application details go to https://slickplan.com/api/register/<client_secret>).

Slickplan implements OAuth2 with the authentication code flow. Read our OAuth2 authentication guide to get started.

Once you have authenticated, you can get information about the authenticated user by calling GET https://slickplan.com/api/v1/me. More details about the request and response are available on the endpoint page.

Rate Limiting

You can perform up to 25 requests per 10 second period on an account with one OAuth token. If you exceed this limit, you'll get a 403 Rate Limit Exceeded response for subsequent requests. Check the Retry-After header to see how many seconds to wait before retrying the request.

Response Codes

  • 200 OK
  • 201 Created
  • 204 No content
  • 400 Bad Request / Validation errors
  • 401 Unauthorized
  • 403 Access denied / Insufficient scope
  • 404 Not found
  • 5xx Slickplan is having trouble

Endpoints

Account

Sitemaps

Sections

Changes

2016-11-20

  • Updated Color Palettes colors array format - each item is now an object with background (background color), text (text color) and level (assigned sitemap page level) attributes
  • Added email_invoices setting to (Preferences)

2016-09-12

  • Added new endpoints:
  • Added new scopes:
    • account_preferences_read
    • account_preferences_write
  • Added Sample Responses page
  • Updated email messages:
    • removed deprecated messages: forgotten_password, forgotten_username, register_confirmation, user_invitation_sitemap, user_invitation_sitemap_exists
    • added new messages: user_invitation_role, user_invitation_permission, user_invitation_role_permission, approved_sitemap, request_unlock, sitemap_unlocked
  • Removed warn_before_leaving_page setting since it is always enabled on all accounts (Preferences)

2015-12-21

  • All dates are now in UTC timezone, Atom format
  • Value of version in sitemap structures is now a string instead of integer
  • Removed childs key from sitemap structures, you can use parent to build hierarchy
  • Added new endpoints:
  • Added new scopes:
    • sitemaps_files_read
    • sitemaps_files_write
    • sitemaps_diagrams_read
    • sitemaps_diagrams_write
    • sitemaps_content_read
    • sitemaps_content_write

2015-08-05

  • Added new grouped scopes:
    • sitemaps_all_read
    • sitemaps_all_write
    • all_read
    • all_write

Support

Having trouble with this API? Contact us directly via email help@slickplan.com.