Developer resources

protocols.io for developers

Getting started

protocols.io API uses RESTful API structure.

You can find API documentation here:

API documentation

Access types

API access is separated into two categories:

  • OAuth access

    Use client id, client secret, and redirect URL to set up OAuth authentication.

    Each user authenticating with protocols.io on your site will have their own OAuth access token.

  • Client access

    You can get your client access token below.

    The client access token allows you to read all public data.

API clients

Choose a client to edit or add new one.

Authentication with OAuth

protocols.io API uses OAuth 2.0 authentication standards.

to authorize a protocols.io user follow these steps:
  • 1Copy your client_id and client_secret from this page.
  • 2Provide your redirect url above.
  • 3Put authorization link inside your application.
  • 4Your requests will be redirected to [your_redirect_url]?code=[new_code]&scope=[your_scope].
  • 5Use the code to get user access_token by calling https://www.protocols.io/api/v3/oauth/token with grant_type: authorization_code.