Mock sample for your project: CIS Automotive API

Hereafter is the documentation of the private API of Pims: Pointages Intelligents pour le Monde du Spectacle. This API is designed for 3rd-party softwares, editors and partners. Its main purpose is to give access the core data of a Pims customer (i.e. events, ticket counts and promotions).
Authentication
The API uses basic access authentication, meaning you will need a username and password to get authorized.
As each customer in Pims has its own domain (e.g. caramba.pims.io, gdp.pims.io...), each credentials will be valid for one domain/customer only. If you need dedicated credentials for one domain, please contact us. (In any case, we will need an explicit agreement from the customer before we create these credentials.)
To make your life easy, you can try all endpoints with the public credentials below, pointing to our demo domain:
Base path: https://demo.pims.io/api
Username: demo
Password: q83792db2GCvgYVdKpU3yG3R
Response format
The API returns JSON and matches the HAL specification. The Content-Type of each response will be application/hal+json, unless an error occurs.
Please note that this documentation describes all responses “as if” they were plain JSON. The specificities of HAL are ignored on purpose, in order to remain compact and avoid repetition.
So when you read in the doc:
{"id" : 123,"property1" :"Lorem ipsum","object" : {"id" : 456,"property2" : 7.89
}
}
... you'll get in the Real World®:
{"id" : 123,"property2" :"Lorem ipsum","embedded" : {"object" : {"id" : 456,"property2" : 7.89,"links" : {"self" : {"href" :"https://api.mydomain.com/other-item/456"
}
}
}
}"_links" : {"self" : {"href" :"https://api.mydomain.com/item/123"
}
}
}
Errors
Errors return JSON too and tries to match the Problem Details for HTTP APIs specification. If it does not match this spec, that's either a bug or a compatibility issue. Please contact us to solve the problem.
The Content-Type of errors will be application/problem+json. The content will match the following JSON:
Filtering and sorting
Every textual filter (e.g. /events?label=U2) and/or sort (e.g. /events?sort=label) performed with the API uses UTF8UNICODECI collation, meaning it is:
Case insensitive: “Chloé” will be considered the same as “CHLOÉ”;
Diacritic insensitive: “Chloé” will be considered the same as “Chloe”.
When performing a sort, it will always be ascending by default. To make it descending, just use a minus sign (-) in front of the parameter value (e.g. /events?sort=-label).
I18n
In responses, some labels can be translated (e.g. promotion types, event input types, etc.). These translatable labels are clearly indicated in the documentation below.
By default, they will be displayed in English, but you can change this behaviour via the Accept-Language header. E.g., use fr as a value for French.
PHP SDK
We provide a simple yet convenient SDK for the PHP language, see the Github page of the project.
And now?
Generaly, you will start by fetching one or more events. An event can be anything that occurs in one venue at one given date and time: a concert, a play, a match, a conference, etc. Additionnally, you can explore the series: a series is just a group of events (e.g. a tour or a festival).
Once you retrieved the events you were interested in, you can look for the sales ( ticket counts):
Get a quick overview with /events/:id/ticket-counts
Or get a full insight by calling these endpoints:
/events/:id/categories
/events/:id/channels
/events/:id/ticket-counts/detailed
Eventually, you may also want to fetch the promotions. A promotion can be anything meant to leverage the sales: ads, marketing campaigns, buzz or news around the event, etc. A promotion can be linked to any combination of events and/or series.

The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were also bought and also viewed.

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, and get account information. For details on the availability of the methods in this API, see Account API requirements and restrictions.

The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.

Service for providing information to sellers about their listings being non-compliant, or at risk for becoming non-compliant, against eBay listing policies.

The Analytics API provides data and information about a seller and their eBay business. The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. The three resources in the Analytics API provide the following data and information: Customer Service Metric – Returns data on a seller's customer service performance as compared to other seller's in the same peer group. Traffic Report – Returns data that shows how buyers are engaging with a seller's listings. Seller Standards Profile – Returns data pertaining to a seller's performance rating. Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. For details on using this API, see Analyzing seller performance.

The REST API of BeezUP system
Overview
The REST APIs provide programmatic access to read and write BeezUP data.
Basically, with this API you will be able to do everything like you were with your browser on https://go.beezup.com !
The main features are:
Register and manage your account
Create and manage and share your stores with your friends/co-workers.
Import your product catalog and schedule the auto importation
Search the channels your want to use
Configure your channels for your catalogs to export your product information:
cost and general settings
category and columns mappings
your will be able to create and manage your custom column
put in place exlusion filters based on simple conditions on your product data
override product values
get product vision for a channel catalog scope
Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product.
Automatize your optimisation by using rules!
And of course... Manage your orders harvested from all your marketplaces:
Synchronize your orders in an uniformized way
Get the available actions and update the order status
...and more!
Authentication credentials
The public API with the base path /v2/public have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials.
We give you the some public list of values and public channels for our public commercial web site www.beezup.com.
The user API with the base path /v2/user requires a token which is available on this page:
https://go.beezup.com/Account/MyAccount
Things to keep in mind
API Rate Limits
The BeezUP REST API is limited to 100 calls/minute.
Media type
The default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json.
Required content type
The required and default encoding for the request and responses is UTF8.
Required date time format
All our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z.
Base URL
The Base URL of the BeezUP API Order Management REST API conforms to the following template.
https://api.beezup.com
All URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template.
You can test our API on https://api-docs.beezup.com/swagger-ui\\
You can contact us on gitter, #BeezUP/API

This API provides access to our Automotive Data. Use of this API is subject to our Terms of Service
For a quick start guide click here
If you signed up through RapidAPI make your test calls here
The general workflow is to: 1. Authenticate with your CIS Automotive API Keys to get a Json Web Token (JWT). Do not use RapidAPI keys.
Then use that token as an argument when calling other endpoints.
Equivalent HTTP GET and POST methods are available for some endpoints.
Endpoints may appear more than once on this page if they are associated with multiple tags. eg "Sales Data", "Premium", "Pro Plan or Greater" To see which endpoints are included in different
plans look under the "X Plan or Greater" tags for the respective plan name.
If you signed up for our API through RapidAPI you can make your test calls on their platform.
Your RapidAPI credentials will not work on this page. Do not use your RapidAPI keys on this page.
If you signed up with us and have an account, you must first authenticate with your API Keys
and retrieve a Json Web Token (JWT) from the /getToken endpoint to access the other endpoints.
Your JWT is a required argument to all endpoints.

Who is this for?
This documentation is for developers creating their own integration with Feedback's API. If you are doing a standard integration, there's a really easy Javascript integration that you should know about before you go to the effort of building your own integration.
Authentication
API calls generally need to be authenticated. Generate an API Key at https://feedback.pendo.io/app/#/vendor/settings?section=integrate. This key should then be added to every request as a request header named 'auth-token' (preferred), or as a query parameter named 'auth-token'.
Endpoint
API endpoint is https://api.feedback.eu.pendo.io / https://api.feedback.us.pendo.io depending where your datacenter is located.
Notes
API endpoints are being added to this documentation as needed by customers. If you don't see an endpoint you need please contact support and if it exists we'll publish the docs here. The 'try it out' feature on this documentation page will probably be blocked by your browser because the Access-Control-Allow-Origin header has its value set by the Feedback server depending on your hostname.
Generating client code
This documentation is automatically generated from an OpenAPI spec available here. You can use Swagger to auto-generate API client code in many languages using the Swagger Editor

カラーミーショップアプリストア API
アプリストアにて公開するアプリに対して、一般公開しているカラーミーショップAPIに加えて、カラーミーショップアプリストアAPI（以下、アプリストアAPIといいます）を利用することが出来ます。アプリストアAPIでは以下のことが行えます。
課金データ(アプリ内課金、従量課金)の作成
インラインスクリプトタグの取得・作成・更新・削除
スクリプトタグの取得・作成・更新・削除
利用手順
アプリストアAPIを利用するには、OAuth認証が必要です。OAuth認証の基本的な流れについてはカラーミーショップAPIドキュメントを参照してください。
アプリストアAPIの利用のために、以下のscopeが追加で指定可能になります。カラーミーショップAPIドキュメントに掲載されているscopeと合わせてご利用ください。
|スコープ|機能|
|---|---|
|writeapplicationcharge|課金データの作成|
|readshopscript_tags|ショップページのスクリプトタグを参照|
|writeshopscript_tags|ショップページへスクリプトタグを追加・更新|
|readinlinescript_tags|インラインスクリプトタグを参照|
|writeinlinescript_tags|インラインスクリプトタグを追加・更新|
|readscripttags|スクリプトタグを参照(deprecated)|
|writescripttags|スクリプトタグを追加・更新(deprecated)|
(例) カラーミーショップアカウントの認証ページを表示

The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and their associated resources. Responses from calls made to getRateLimits and getUerRateLimits include a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. The getRateLimits and getUserRateLimits methods retrieve call-limit information for either an application or user, respectively, and each method must be called with an appropriate OAuth token. That is, getRateLimites requires an access token generated with a client credentials grant and getUserRateLimites requires requires an access token generated with an authorization code grant. For more information, see OAuth tokens. Users can analyze the response data to see whether or not a limit might be reached, and from that determine if any action needs to be taken (such as programmatically throttling their request rate). For more on call limits, see Compatible Application Check.

Allows sellers to: 1) Load products definitions to the BrandLovers marktplace. 2) Receive and update orders status. 3) Receive and update shipping information. 4) Receive and update customer tickets. All requests consume and return application/json content. All request must be authenticated and use HTTPS.