Introduction

Optimus is a REST API designed for the Soulbound Platform. It provides developers with easy access to the platform's features, enabling them to build applications and services that leverage its power. Optimus simplifies the integration process, allowing developers to focus on creating value for their users rather than worrying about technical details.

Authentication

A user must use an OpenID Connect provider (e.g. "Connect with Google") to log into the system.

Authorization

Once logged in, the user needs to generate an OAuth 2.0 Access Token and provides it to the application that will interact with the API Server. The Access Token confirms that API requests are being issued at the user's request.

Relationship Between Authentication and Authorization Servers

OpenID Connect is implemented on top of the OAuth 2.0 protocol, so some OAuth 2.0 clients may implement OpenID Connect as well.

Related:

• An Illustrated Guide to OAuth and OpenID Connect
• ID Tokens VS Access Tokens: What's the Difference?

Resource hierarchy

• Organizations
  • Projects
    • Events

Projects

• List an organization's projects
• Create a project
• Update a project
• Get the state of a project
• Remove a project

Events

• Create a Generic Event

Developer resources: https://www.oauth.com/oauth2-servers/the-resource-jdbcUrl/ discusses the WWW-Authenticate header.