API Resources

Welcome to the eOptin Authorize Connect API Resource. The API enables developers to communicate with eOptin data from within their own applications or electronic devices.

These docs describe version 1.0 of the eOptin Authorize Connect API.
  • Making Requests
The eOptin Authorize Connect API works over the HTTP protocol. It supports both server-side (secret key) methods, as well as a public facing JavaScript API using your public key and HTTP referrer checks. In general, read requests are made with GET and write requests are made with POST
  • Authentication in the API
The API supports the following methods for making authenticated API requests:
OAuth 2
With OAuth, your API requests are considered anyonymous (only public data is returned) until you obtain an access token which permits you to make requests on behalf of a user. To obtain an access token, you redirect users to a special eOptin login page which asks users to grant your application access. OAuth needs to be enabled for your API key.
Single sign-on
Single sign-on authentication is only for SSO users (Pro and VIP accounts). It enables you to make API requests on behalf of an SSO user, given the correct SSO authenticate string.

  • Permissions and Scopes
eOptin implements permissions slightly different than what you may expect. For starters, every request has a base set of explicit permissions depending on the authenticated user. Generally those permissions are defined as part of the scope as part of the authentication process. On top of this, every object also has it's own scoping for those same permissions.
  • Error Codes
Every error is represented with an HTTP status code, as well as a code and response message within the actual response body.
  • API Client Libraries
eOptin maintains several official API bindings