REST API

The Marketplace Platform REST API lets you interact with the platform programmatically.

Our API is organized around REST, has predictable resource-oriented URLs, uses JSON-encoded representations, and standard HTTP response codes, authentication, and verbs.

The platform offers several REST APIs for tasks, like managing orders and viewing users and accounts. Each API works similarly, whether you access it directly over HTTP or through helper libraries in various programming languages.

Authentication

The Marketplace Platform uses API tokens to authenticate requests. You can view and manage your API keys in the user interface of your account settings. Include your API token in the 'Authorization' HTTP header with the 'Bearer' prefix for authentication.

For example, the following request could be used to retrieve a list of buyers:

GET https://api.platform.softwareone.com/public/v1/accounts/buyers
Authorization: Bearer {TOKEN_VALUE}

Your API keys have permissions assigned to them, so keep them secure. Don't share your secret API keys in public areas, like GitHub or client-side code.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Content type

The Marketplace Platform API expects the content type of API requests to be 'application/json' in most cases (except for cases where 'multipart/form-data' is used to send attachments)

GET https://api.platform.softwareone.com/public/v1/accounts/buyers
Authorization: Bearer {TOKEN_VALUE}
Content-Type: application/json

To communicate successfully with the Marketplace Platform APIs, ensure your API requests are formatted using the 'application/json' content type. Using the wrong content type can result in unexpected behavior or errors.