The Beta endpoints for the new Email Activity APIs - functionality is subject to change without notice. You may not have access to this Beta endpoint. Email Activity offers filtering and search by event type for two days worth of data. There is an optional add-on to store 60 days worth of data. This add-on also gives you access to the ability to download a CSV of the 60 days worth of email event data. The Beta endpoints for the new Email Activity APIs - functionality is subject to change without notice. You may not have access to this Beta endpoint. Email Activity offers filtering and search by event type for two days worth of data. There is an optional add-on to store 60 days worth of data. This add-on also gives you access to the ability to download a CSV of the 60 days worth of email event data.
The setlist.fm API has been designed to give you easy access to setlist data in order to build fancy websites and other applications. Before starting to use the API, be sure to ...
- ... understand how setlist.fm works (the FAQ and the Guidelines are a good starting point),
- ... read this documentation carefully and
- ... apply for an API key (link for logged in users only) - if you're no registered user yet, then register first (it's free).
If this documentation isn't enough or if you've got other things you'd like to tell us about the API, visit the API Forum.
Note that the setlist.fm API is, according to the API terms of service, only free for non-commercial projects. If you're interested in using the API for commercial purposes, contact us.
About this Service
This service provides methods to get both setlists and components of setlists such as artists, cities, countries or venues.
Supported Content Types
The REST service currently supports XML (default) and JSON content.
To receive a JSON response, set the Accept
header to application/json.
Internationalization
(Please note that this is an experimental feature and does not work for all cities!)
Most of the featured methods honor the Accept-Language
header. This header is used for
localizing cities and countries. The default language is English (en), but you can provide any of the languages
Spanish (es), French (fr), German (de), Portuguese (pt), Turkish (tr), Italian (it) or Polish (pl).
E.g. if you search a setlist for a concert that took place in Vienna and you pass "de" as header, you'll
get "Wien, Österreich" instead of "Vienna, Austria".
This also works if you use a different language than the country's native language.
E.g. for a concert in New York, you'll get "Nueva York, Estados Unidos" instead of "New York, United States" if you pass "es" as language.
API Keys
API keys (application form) must be included in the request with thex-api-key
header.
Version History
Version | Docs | End of Service |
---|---|---|
1.0 | Docs | - |
0.1 | December 31, 2017 |
# Introduction This API returns information about all of the verses in Rig Veda. The results are JSON objects that contain the name of the god, poet, and meter of the verses in Rig Veda, the category of the god and the poet, and the _mandal_ and _sukta_ number. The API uses the Swagger 2.0 specification. # Authentication This is an open API. # Try it out This sandbox can be used to get data for only one kind of resource, that is, to fetch the data for a category being sung to. The remaining resources work a similar fashion. For details, see the reference documentation.
# Introduction This API returns data regarding almost all nouns in vedic literature. The results are JSON objects that contain the word transliterated to the Roman script, the word in the Nagari script, the meaning of the word, and the category the word belongs to. Proper nouns are not included (yet). The API uses the Swagger 2.0 specification. # Authentication This is an open API. # Try it out This sandbox can be used to get data for only one kind of resource, that is, to fetch data for a string contained in the meaning of any of the words. The remaining resources work a similar fashion. For details, see the reference documentation.
ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
# カラーミーショップアプリストア API
[アプリストア](https://app.shop-pro.jp/)にて公開するアプリに対して、一般公開している[カラーミーショップAPI](https://developer.shop-pro.jp/docs/colorme-api)に加えて、カラーミーショップアプリストアAPI(以下、アプリストアAPIといいます)を利用することが出来ます。アプリストアAPIでは以下のことが行えます。
- 課金データ(アプリ内課金、従量課金)の作成
- インラインスクリプトタグの取得・作成・更新・削除
- スクリプトタグの取得・作成・更新・削除
## 利用手順
アプリストアAPIを利用するには、OAuth認証が必要です。OAuth認証の基本的な流れについては[カラーミーショップAPIドキュメント](https://developer.shop-pro.jp/docs/colorme-api)を参照してください。
アプリストアAPIの利用のために、以下のscopeが追加で指定可能になります。[カラーミーショップAPIドキュメント](https://developer.shop-pro.jp/docs/colorme-api)に掲載されているscopeと合わせてご利用ください。
|スコープ|機能|
|---|---|
|`write_application_charge`|課金データの作成|
|`read_shop_script_tags`|ショップページのスクリプトタグを参照|
|`write_shop_script_tags`|ショップページへスクリプトタグを追加・更新|
|`read_inline_script_tags`|インラインスクリプトタグを参照|
|`write_inline_script_tags`|インラインスクリプトタグを追加・更新|
|`read_script_tags`|スクリプトタグを参照(deprecated)|
|`write_script_tags`|スクリプトタグを追加・更新(deprecated)|
(例) カラーミーショップアカウントの認証ページを表示
```
https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&scope=read_products%20write_products%20write_application_charge
```
## 課金設定
料金プラン(月額課金・従量課金・買い切り)による課金や、アプリ内課金をご利用いただくにはアプリごとに課金設定の登録が必要です。
この設定は [カラーミーショップ デベロッパー](https://developer.shop-pro.jp) から行うことができます。
登録できる課金形式やその使い方の詳細については[アプリストア 開発ガイドのアプリ課金のページ](https://developer.shop-pro.jp/getting-started/appstore-billing/)をご覧ください
## アプリのインストール
ショップオーナーがアプリをインストールしたとき、以下の処理をカラーミーショップが行います。
- 選択された料金プランに基づき課金開始
- インストールフックの呼び出し
### インストールフック
アプリのインストール時に、インストールに関する情報を `POST` メソッド、 `application/json` 形式で通知します。
通知先のURLは[カラーミーショップ デベロッパー](https://developer.shop-pro.jp/)にログインし、各アプリストア アプリのアプリ設定から登録を行ってください。
以下のパラメータが送信されます。課金請求に必要なパラメータを含みますので、必ず受け取れるようにしてください。
|パラメータ|機能|形式|
|---|---|---|
|`account_id`|インストールしたショップオーナーのアカウントID|PA+8桁の整数|
|`application_charge_source_id`|プラン課金ID|数字と大文字アルファベットで構成される文字列(6桁以上)|
|`recurring_application_charge_id`|(買い切り以外の課金の場合)課金契約ID|数字と大文字アルファベットで構成される文字列(6桁以上)|
|`application_charge_id`|(買い切りの場合)課金契約ID|数字と大文字アルファベットで構成される文字列(6桁以上)|
|`trial_term`|(無料お試し期間がある場合)無料お試し期間|JSONオブジェクト|
|`mail`|ショップオーナーへの連絡メールアドレス|文字列|
`application_charge_source_id` はデベロッパーサイトで設定したプラン課金のIDです。インストールされた料金プランの判別にご利用いただけます。
`recurring_application_charge_id` と `application_charge_id` はインストールごとに発行されるユニークなIDです。ショップオーナーが一度アンインストールした後に、再度同じショップオーナーがアプリのインストールを行った際には新たに別のIDが発行されます。
`recurring_application_charge_id` は「買い切り」以外の課金である「無料」「月額」「月額+従量」「月額+初期費用」「従量のみ」のプラン課金のインストールの際に発行されます。
従量による課金を伴うプラン課金の場合は、従量分の料金を請求する際に 課金契約ID(`recurring_application_charge_id`) が必要になるので、必ず記録するようにしてください。
`mail` パラメータの値はショップオーナーへの連絡手段としてご利用いただけます。インストール後に認可フローが中断され、アクセストークンが得られない際のショップオーナーへの連絡手段としてご活用いただけます。このパラメータはカラーミーショップの非公開情報として登録されている値です。左記以外の用途でこの値をアプリの機能で使用しないでください。
例) 買い切りの場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"application_charge_id": "A3FT4N",
"mail": "shop@example.com"
}
```
例) 月額課金の場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"recurring_application_charge_id": "A3FT4N",
"mail": "shop@example.com"
}
```
無料お試し期間を設定した課金の場合、以下の情報を `trial_term` パラメータとして送信します。
無料お試し期間中は従量課金APIを呼び出して課金請求することはできません。
|パラメータ|機能|形式|
|---|---|---|
|`starts_at`|無料お試し開始日時|整数値(UNIXタイムスタンプ)|
|`ends_at`|無料お試し終了日時|整数値(UNIXタイムスタンプ)|
例) 無料お試し期間がある月額課金の場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "F3RN9A",
"recurring_application_charge_id": "A3FT4N",
"mail": "shop@example.com",
"trial_term" {
"starts_at": 1565017200,
"ends_at": 1567609200
}
}
```
受け取りに成功した場合は、以下のパラメータを `application/json` 形式でレスポンスボディに付与し、
ステータスコード `200` レスポンスをカラーミーショップへ返却してください。
ステータスコード `200` レスポンスをカラーミーショップが受け取れない場合、もしくは以下のパラメーターが返却されなかった場合、インストールを中止し、インストールによって発生した情報は破棄されます。
|パラメータ|機能|形式|
|---|---|---|
|`redirect_url`|インストール成功後に遷移するURL|文字列(URL)|
例)
```
{
"redirect_url": "https://example.com"
}
```
インストール完了後、インストールフックのレスポンスパラメータの `redirect_url` へ画面遷移しますので、APIを利用する場合は `redirect_url` より先の画面でOAuth認証の実装をお願いします。
## アプリのアンインストール
ショップオーナーがアプリをアンインストールしたとき、以下の処理をカラーミーショップが行います。
- OAuth認証のアクセストークンの無効化
- 登録したインラインスクリプトタグ・スクリプトタグの削除
- 月額課金形式の場合、継続課金の無効化
### アンインストールフック
アンインストール直後に `POST` メソッドで、以下の情報を `application/json` 形式で通知します。
通知先のURLは[カラーミーショップ デベロッパー](https://developer.shop-pro.jp/)にログインし、各アプリストア アプリのアプリ設定から登録を行ってください。
※ [アンインストールAPI](#operation/deleteInstallation)のご利用によるアンインストール時はアンインストールフックは通知されません。
受け取りに成功した場合はステータスコード `200` のレスポンスを返却してください。
|パラメータ|機能|形式|
|---|---|---|
|`account_id`|アンインストールしたショップオーナーのアカウントID|PA+8桁の整数|
|`application_charge_source_id`|プラン課金ID|数字と大文字アルファベットで構成される文字列(6桁以上)|
|`uninstalled_at`|アンインストール日時|整数値(UNIXタイムスタンプ)|
|`reason`|アンインストール理由| `by_shop_owner` (ショップオーナーによる)
`by_unpaid` (未払いによる) |
|`recurring_application_charge_id`|(買い切り以外の課金の場合)課金契約ID|数字と大文字アルファベットで構成される文字列(6桁以上)|
|`usage_charge`|(従量課金の場合)従量課金アンインストール情報|JSONオブジェクト|
アンインストールフックの通知が伴うアンインストールは以下の操作のいずれかによって行われます。アンインストールの理由を `reason` パラメータで確認できます。
|reasonパラメータの値|アンインストール理由|
|---|---|
|`by_shop_owner`|ショップオーナーによるアンインストール操作|
|`by_unpaid`|ポイント不足による利用料徴収の失敗による自動アンインストール|
課金契約ID `recurring_application_charge_id` はインストールフックで通知したIDと同じIDが通知されます。
料金プランが従量課金の場合、アンインストール後に従量課金データの作成を可能にするために、以下の情報を `usage_charge` パラメータとして送信します。
アンインストール後はOAuthのアクセストークンが無効化されているため、アクセストークンを利用して従量課金APIを呼び出すことができなくなります。
アンインストール後はアクセストークンの代わりに `api_token` をリクエストヘッダーに含め、従量課金APIを呼び出してください。
無料お試し期間中にアプリがアンインストールされた場合は、`api_token` は発行されません。
詳しくは、[従量課金データの作成](https://app.shop-pro.jp/open_api#operation/createUsageCharge)を参照してください。
`api_token` を利用した従量課金APIの呼び出しは、ポイント締め日 `closing_on` までとなっておりますので、ご注意ください。
|パラメータ|機能|形式|
|---|---|---|
|`api_token`|アンインストール後に従量課金APIを利用いただくために必要な情報|文字列|
|`closing_on`|ポイント締め日|整数値(UNIXタイムスタンプ)|
通常、 `closing_on` は、アンインストール直前まで利用されていた契約の期間の月末となります。以下に例を示します。
|アンインストール日|直前まで利用されていた契約の期間|closing_on の示す日時|
|---|---|---|
|2021/01/09|2021/12/10〜2021/01/09|2021/01/31|
|2021/01/10|2021/01/10〜2021/02/09|2021/02/28|
従量課金の場合のユーザーの契約期間については[こちら](https://shop-pro.jp/manual/appstore_fee)をご参照ください
アンインストールフックの例を以下に示します。
例) 買い切りの場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "Q21GPC",
"uninstalled_at": 1552022739,
"reason": "by_shop_owner"
}
```
例) 月額課金の場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "EW3V21",
"recurring_application_charge_id": "F3RN9A",
"uninstalled_at": 1552022740,
"reason": "by_shop_owner"
}
```
例) 従量課金を含む月額課金の場合
```
{
"account_id": "PA00000001",
"application_charge_source_id": "WA37CA",
"recurring_application_charge_id": "F3WQ1S",
"uninstalled_at": 1552022740,
"reason": "by_shop_owner",
"usage_charge": {
"api_token": "token",
"closing_on": 1552533465
}
}
```
### アンインストールフックのリトライ
ステータスコード `200` のレスポンスをカラーミーショップが受け取れない場合は、ステータスコード `200` をカラーミーショップが受け取るまで、以下の条件で再度アンインストール情報を送信します。
なお、カラーミーショップによるアンインストール処理は、アンインストールフックの送信結果の成否によらず、アンインストールが実行されたときに完了します。
- 2時間30分ごとにアンインストールフックの仕様に基づき再送します
- 最大で合計19回再送します
- すべての再送の試行でステータスコード `200` をカラーミーショップが受け取れない場合は、公認デベロッパー申請時に登録されたメールアドレス宛にメールを送信します
## インストール・アンインストールフックの署名検証
`X-Appstore-Signature` リクエストヘッダーに含まれる署名を検証して、リクエストがカラーミーショップから送信されたことを確認することを推奨します。
検証の手順は以下のとおりです。
1. カラーミーショップが発行した `webhook_secret` を秘密鍵として、HMAC-SHA256アルゴリズムを使用してリクエストボディのダイジェスト値を取得します。
2. ダイジェスト値をBase64エンコードした値とリクエストヘッダーに付与された署名( `X-Appstore-Signature` の値)が一致することを確認します。
サンプルコード(ruby)
```ruby
WEBHOOK_SECRET = 'my_webhook_secret'
payload_body = request.body.read
signature = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', WEBHOOK_SECRET, payload_body))
ActiveSupport::SecurityUtils.secure_compare(signature, request.env['HTTP_X_APPSTORE_SIGNATURE'])
```
### 発信元IPアドレスについて
発信元IPアドレスは固定ではありません。そのためIPアドレスが固定されていることを前提としてアプリケーションを開発しないでください。
インストールフックおよびアンインストールフックのリクエストの発信元を検証する場合は上記の署名検証を行なってください。
## Introduction The Shorten.rest API allows you to programmatically create short URLs (an 'alias') for longer URL (a 'destination'). Each alias you create can be used to redirect the end user (person clicking on the link) to one or more destination URLs A default destination is always set and specific destinations can be set to redirect the end user to preferred destinations based on the user's geographical location (country) and device Operating System. In order to use the Shorten.Rest URL Shortening API you can choose to bind your own branded domain, sub-domain or to use our default domain - Short.FYI ### Destination Matching When creating or editing a short URL ('alias') you can choose to specify a destination for each country and OS ([Supported OSes list](#tag/OperatingSystems)) combination. When a user clicks on the short link, Shorten.rest will examine the end user's country (determined by User's IP) and OS (User agent) and match the most suitable destination for each user. (*) If no destination is set for a specific request combination Shorten.rest will use the default destination that exists within each short URL (**) BRANDED DOMAINS: If the requested alias does not exist in our database - Shorten.rest will redirect the user to the default fallback you set within your dashboard under the ‘Alias Not Found Page Url’ value for a custom domain. (***) Operating System (OS) destinations are stronger than a country destination! For example - if you have a custom landing page that is targeting people in the USA and a second landing page that is hyper focused for people who use iOS devices - a person clicking on your link in the USA that is on an iPhone will be redirected to the iOS landing page, while all other devices will be redirected to the USA landing page. | OS | Country | Destination | | :------------: |:---------------:| -----| | iOS | | YourDestination.com/ios | | | US | YourDestination.com/usa | Shorten.rest will choose the YourDestination.com/ios url as the most suitable destination. ### Branded Domain Attributes When setting up your custom domain you can include optional metatags and snippets ([Supported snippets list](#tag/Snippets)). These parameters (such as retargeting, tracking and conversion pixels) are populated and fired on click - at the time of the redirect. By default the parameters you set in the domain setting will be included in all Short URLs associated with that domain. You can always override the domain defaults for each URL by passing the appropriate variables when creating or updating a short URL ### Setting a Custom string for an Alias (short.fyi/alias) While creating a short URL you can specify which domain to use. You can choose to use your own branded domain or our default domain - Short.fyi. Each Alias is unique within a domain they are related to. This means that if multiple accounts use you the same domain (for example short.fyi), if an alias is already taken you may not create a new destination for it. That said - If you would like to use a specific alias which is already taken - the only way to do so is to create it on a new domain you own and have attached to your Shorten.rest account. ### Random Aliases By default - unless you specify a vanity URI for your alias each URL that is shortened on our platform will have a random string generated by the API. This means that if the 'alias' attribute of a /aliases POST request is not provided, or is an empty string, a random string of seven characters will be generated and returned as part of the POST response. You can also place the @**rnd** macro within the alias field when you create a new alias, for example /vanity/@rnd, which might return an alias like /vanity/ZMAefRt, or /vanity@rnd, which might produce something like /vanityMRtvxadf. Only the first @rnd in an alias attribute will be replaced. ### NOTES ( * ) All methods of the Shorten.REST API require that your API key be provided in **x-api-key** header. (**) All API parameters are case sensitive
Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version}