OpenChannel Market API
OpenChannel Market API endpoints from Openchannel
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
OpenChannel Market API endpoints from Openchannel
Endpoints 72
apps : Find and modify apps
- GETReturns a paginated list of APPROVED or SUSPENDED apps
/apps?query=string&sort=string&pageNumber=0&limit=0&userId=string&isOwner=trueResults are paginated and the default is value is 1000 if no limit is provided If no query is specified, returns all APPROVED or SUSPENDED apps within the… - POSTAdds a new app for this developer
/apps?developerId=string&name=string&type=string&model=string&customData=string&attributes=string&restrict=string&allow=string&access=stringThis method is called on behalf of a developer. Price is required if the model is 'single' or 'recurring' Returns the newly created app - GETReturns a single APPROVED or SUSPENDED app
/apps/bySafeName/:safeName?userId=string&trackViews=trueA 'view' event is recorded when trackViews is set to true - GETSearches through the text of fields to find APPROVED or SUSPENDED apps
/apps/textSearch?query=string&text=string&fields=string&pageNumber=0&limit=0&userId=string&isOwned=trueResults are returned for the market provided within the basic authentication credentials - GETReturns a paginated list of AppVersions
/apps/versions?query=string&sort=string&pageNumber=0&limit=0&developerId=stringResults are paginated when limit is set, otherwise all results are returned If no query is specified, returns all AppVersions within the marketplace Only… - GETReturns a single APPROVED or SUSPENDED app
/apps/:appId?userId=string&trackViews=trueA 'view' event is recorded when trackViews is set to true - DELETERemoves app and all versions
/apps/:appId?developerId=stringThis method is called on behalf of a developer. - POSTChange the live app to another, previously approved version
/apps/:appId/live?developerId=string&version=stringThis method is called on behalf of a developer. - POSTPublishes the current working version of the app to the marketplace
/apps/:appId/publish?developerId=string&version=0&autoApprove=trueThis method is called on behalf of a developer. Only effects the current working version of the app. - GETReturns a single AppVersion
/apps/:appId/versions/:version?developerId=stringOnly returns AppVersions owned by this developer - POSTUpdates the app or creates a new version
/apps/:appId/versions/:version?developerId=string&name=string&type=string&model=string&customData=string&attributes=string&restrict=string&allow=string&access=string&approvalRequired=stringThis method is called on behalf of a developer. Price and is required if the model is 'single' or 'recurring' Returns the newly updated app This endpoint… - DELETERemoves AppVersion
/apps/:appId/versions/:version?developerId=stringThis method is called on behalf of a developer. - PATCHUpdates the app fields or creates a new version
/apps/:appId/versions/:version?developerId=string&name=string&type=string&model=string&customData=string&attributes=string&restrict=string&allow=string&access=string&approvalRequired=stringThis method is called on behalf of a developer. Price and is required if the model is 'single' or 'recurring' Returns the newly updated app This endpoint… - POSTAllows a developer or administrator to change the status of apps
/apps/:appId/versions/:version/status?developerId=string&status=inReview&modifiedBy=administrator&reason=stringOnly certain status changes are allowed. For instance, a developer is only able to suspend and unsuspend their app (which must already be approved). See here…
custom-gateway : Process payments and refunds
- POSTAdds a payment for an app on behalf of a user
/custom-gateway/payment/:ownershipId?amount=0&date=0&feeAmount=0&marketplaceAmount=0&developerAmount=0&customData=stringResults are returned for the market provided within the basic authentication credentials Payments must be enabled and 'Custom' must be selected as the gateway… - POSTFully or partially refund payment for an app on behalf of a user
/custom-gateway/refund/:ownershipId?amount=0&date=0&feeAmount=0&marketplaceAmount=0&developerAmount=0&customData=stringResults are returned for the market provided within the basic authentication credentials Payments must be enabled and 'Custom' must be selected as the gateway…
developerAccounts : Find and modify developer accounts
- GETReturns a paginated list of developerAccounts
/developerAccounts?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 1000 if no limit is provided - GETReturns a single developer account
/developerAccounts/:developerAccountId - POSTUpdates the developer account or adds the developer account if it doesn't exist
/developerAccounts/:developerAccountId?developerId=string&email=string&name=string&customData=string - DELETERemoves the developer account
/developerAccounts/:developerAccountId - PATCHUpdates the developer account fields
/developerAccounts/:developerAccountId?developerId=string&email=string&name=string&customData=string
developers : Find and modify developers
- GETReturns a paginated list of developers
/developers?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 100 if no limit is provided - GETReturns a single developer
/developers/:developerId - POSTUpdates the developer record or adds the developer if it doesn't exist
/developers/:developerId?type=string&email=string&username=string&name=string&customData=string - DELETERemoves a single developer
/developers/:developerId - PATCHUpdates the developer fields
/developers/:developerId?type=string&email=string&username=string&name=string&customData=string
events : Find events
- GETReturns an event
/events/:eventIdResults are returned for the market provided within the basic authentication credentials
files : Upload files
- GETReturns a paginated list of files
/files?query=string&sort=string&pageNumber=0&limit=0 - POSTUploads a file.
/files?isPrivate=true&hash=stringWARNING: File URLs or fileIds must be stored somewhere within the customData field for an app, review, developer or user. Unused files will be removed after a… - GETGet the details for a file.
/files/byIdOrUrl?fileIdOrUrl=string - GETA signed URL for downloading a private file can be returned by providing the fileId.
/files/download?fileId=string&validSeconds=0 - POSTUploads a file from a URL
/files/url?url=string&isPrivate=trueWARNING: File URLs or fileIds must be stored somewhere within the customData field for an app, review, developer or user. Unused files will be removed after a…
markets : This marketplace
- GETReturns the current marketplace
/markets/this
ownership : Find ownership
- GETReturns a paginated list of app licenses
/ownership?query=string&sort=string&pageNumber=0&limit=0Results are returned for the market provided within the basic authentication credentials - POSTAquires an app license for a user (installs app)
/ownership/install?appId=string&userId=string&modelId=string&model=string&customData=stringThis method is called on behalf of a user - This method requires either a modelId from the app or a custom model - User data and statistics are recorded when… - POSTUninstalls a license for a particular user and app (uninstalls app)
/ownership/uninstall/:ownershipId?userId=string&cancelOwnership=true&customData=stringThis method is called on behalf of a user - User data and statistics are recorded when this method is called - GETReturns an ownership record
/ownership/:ownershipIdResults are returned for the market provided within the basic authentication credentials - POSTUpdates an ownership record
/ownership/:ownershipId?customData=string&expires=0Results are returned for the market provided within the basic authentication credentials - PATCHUpdates ownership fields
/ownership/:ownershipId?customData=string&expires=0Results are returned for the market provided within the basic authentication credentials
permission : Add and remove permissions
- GETReturns permission that allows the app to access this user's data
/permission/apps/:appId?userId=string - POSTAdds permission to allow the app to access this user's data
/permission/apps/:appId?userId=string&date=0&ip=string - DELETERemoves permission that allows the app to access this user's data
/permission/apps/:appId?userId=string
reviews : Find and modify reviews
- GETFind reviews for a particular App and marketplace. Results are automatically paginated when limit is set
/reviews?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 100 if no limit is provided - POSTPost a review from a User and returns the new post
/reviews?appId=string&userId=string&userAccountId=string&headline=string&rating=0&description=string&type=string&mustOwnApp=true&autoApprove=true&customData=stringOnly authenticated users are able to post reviews Returns the newly created review - GETFind a Review within a particular App and marketplace
/reviews/:reviewId - POSTUpdate a review from a User and returns the new post
/reviews/:reviewId?userId=string&userAccountId=string&headline=string&rating=0&description=string&customData=stringOnly the review author is able to update their review Returns the newly updated review - DELETERemove a review
/reviews/:reviewId?userId=string&userAccountId=stringOnly the review author is able to remove their review - PATCHUpdate a review fields
/reviews/:reviewId?userId=string&userAccountId=string&headline=string&rating=0&description=string&customData=stringOnly the review author is able to update their review Returns the newly updated review
stats: Find marketplace statistics
- POSTIncrements a statistics field
/stats/increment/:field?appId=string&userId=string&value=0&date=0increment a statistics field - GETReturn a timeseries for a particular field
/stats/series/:period/:fields?start=0&end=0&query=stringReturn a timeseries nested array containing date and value. Example: [[1406520000000,2],[1406606400000,34],[1406692800000,245],...] - GETReturns the total number of events for a particular field.
/stats/total?fields=string&query=string&start=0&end=0
stripe-gateway : Process payments and refunds
- GETReturns a developers connected Stripe accounts
/stripe-gateway/developer/:developerId/accountsResults are returned for the market provided within the basic authentication credentials - POSTGenerate a temporary URL to allow a developer to connect their Stripe account
/stripe-gateway/developer/:developerId/accounts?redirectUrl=stringResults are returned for the market provided within the basic authentication credentials The URL generated by this method is only valid for 48 hours. - DELETEDisconnects a developer's Stripe account
/stripe-gateway/developer/:developerId/accounts/:stripeIdResults are returned for the market provided within the basic authentication credentials - GETReturns credit cards for this user
/stripe-gateway/user/:userId/cardsResults are returned for the market provided within the basic authentication credentials - POSTAdds credit card for this user
/stripe-gateway/user/:userId/cards?token=string&isDefault=trueResults are returned for the market provided within the basic authentication credentials - POSTUpdates a credit card for this user
/stripe-gateway/user/:userId/cards/:cardId?isDefault=true&address_city=string&address_country=string&address_line1=string&address_line2=string&address_state=string&address_zip=stringResults are returned for the market provided within the basic authentication credentials - DELETERemoves a credit card for a user
/stripe-gateway/user/:userId/cards/:cardId
transactions : Find payments and refunds
- GETReturns a paginated list of transactions
/transactions?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 100 if no limit is provided - GETReturns a transaction
/transactions/:transactionIdResults are returned for the market provided within the basic authentication credentials - POSTUpdates a transaction
/transactions/:transactionId?customData=stringResults are returned for the market provided within the basic authentication credentials - DELETEDeleted a transaction
/transactions/:transactionIdResults are returned for the market provided within the basic authentication credentials
userAccounts : Find and modify user accounts
- GETReturns a paginated list of userAccounts
/userAccounts?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 1000 if no limit is provided - GETReturns a single user account
/userAccounts/:userAccountId - POSTUpdates the user account or adds the user account if it doesn't exist
/userAccounts/:userAccountId?userId=string&email=string&name=string&customData=string - DELETERemoves the user account
/userAccounts/:userAccountId - PATCHUpdates the user account fields
/userAccounts/:userAccountId?userId=string&email=string&name=string&customData=string
users : Find and modify users
- GETReturns a paginated list of users
/users?query=string&sort=string&pageNumber=0&limit=0Results are paginated and the default is value is 100 if no limit is provided - GETReturn a single user
/users/:userIdResults are returned for the market provided within the basic authentication credentials - POSTUpdates a single user or adds the user if they don't exist
/users/:userId?type=string&email=string&username=string&name=string&customData=string - DELETERemoves a single user
/users/:userIdResults are returned for the market provided within the basic authentication credentials - PATCHUpdates user fields
/users/:userId?type=string&email=string&username=string&name=string&customData=string
API details
- Base URL
https://market.openchannel.io/v2- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 72 operations on 41 pathsGET 30POST 24DELETE 11PATCH 7
- Main resources
- apps : Find and modify apps 14stripe-gateway : Process payments and refunds 7ownership : Find ownership 6reviews : Find and modify reviews 6developerAccounts : Find and modify developer accounts 5developers : Find and modify developers 5files : Upload files 5userAccounts : Find and modify user accounts 5users : Find and modify users 5transactions : Find payments and refunds 4
- Response formats
*/*- Description format
- OpenAPI 3.0.0, API version
2.0.24 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the OpenChannel Market API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OpenChannel Market API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Returns a paginated list of APPROVED or SUSPENDED apps” (GET /apps?query=string&sort=string&pageNumber=0&limit=0&userId=string&isOwner=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the OpenChannel Market API?
OpenChannel Market API endpoints from Openchannel It is listed under Other and has 72 endpoints.
Who publishes the OpenChannel Market API?
It is listed from Openchannel's public API description (an OpenAPI document), not published by Openchannel on Swastik Codes. Anyone who controls openchannel.io can claim the profile by adding a DNS TXT record.
What is the base URL of the OpenChannel Market API?
Requests go to https://market.openchannel.io/v2. Endpoint paths are added to this base URL.
How do I authenticate with the OpenChannel Market API?
With HTTP Basic authentication (username and password).
How many endpoints does the OpenChannel Market API have?
72 operations on 41 paths (30 GET, 24 POST, 11 DELETE, 7 PATCH). The largest groups are apps : Find and modify apps, stripe-gateway : Process payments and refunds, ownership : Find ownership, reviews : Find and modify reviews.
Is forking the OpenChannel Market API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.