Mock sample for your project: Pims API

Integrate with "Pims API" from pims.io in no time with Mockoon's ready to use mock sample

Pims

pims.io

Version: 1.0


Use this API in your project

Integrate third-party APIs faster by using "Pims API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.

Description

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.

Other APIs in the same category

Swagger API2Cart

API2Cart

Zettle Product Library API

A product library is a representation of all the items that can be
displayed, put in a shopping cart and sold to a customer. Items may be
either producs or discounts.
A product is a synthetic construct, wrapping one or more variants (which is
the actual item being sold) Variants expresses different variations of
properties such as for example price, size or color. A discount will reduce
the total amount charged in a shopping cart. It can be used per item line,
or on the whole cart. It may reduce the affected amount by a percentage, or
by a fixed amount.
Together, the above types of entities makes up a complete library. The
library can be fetched as a whole through the library endpoint, where each
consecutive change applied to the library is available. Once the full
library is retrieved, only later events needs to be fetched to keep the
client up to date with the server
All path patterns "/organizations/{organizationUuid}/" can be replaced
with "/organizations/self/" for convenience as all endpoints are for
authorized users.

Account API

ebay.com
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.

Buy Marketing API

ebay.com
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.

Item Feed Service

ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file of the items that have changed within an hour for a specific category, date and marketplace. In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.

Jumpseller API

jumpseller.com
Endpoint Structure
All URLs are in the format:
More
Jumpseller API wrapper provides a public Ruby abstraction over our API;
Apps Page showcases external integrations with Jumpseller done by technical experts;
Imgbb API provides an easy way to upload and temporaly host for images and files.

Marketcheck APIs

apigee.net
One API serving data spanned across multiple verticals

Compliance API

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

Listing API

ebay.com
Note: This is a (Limited Release) API available only to select developers approved by business units. Enables a seller adding an ad or item on a Partner's site to automatically create an eBay listing draft using the item details from the Partner's site.

papiNet API

papinet API is a global initiative for the Forst and Paper supply chain.

Metadata API

ebay.com
The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces. In addition to marketplace information, the API also has operations that get information that helps sellers list items on eBay.

カラーミーショップアプリストア API

カラーミーショップアプリストア 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)|
(例) カラーミーショップアカウントの認証ページを表示