Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md

README.md

Overview

This describes the basics of Gifly API V1 resource.

Current Version

The default version of the current Gifly API is V1.

Schema

All the APIs must access to https://api.gifly.jp. The data format is JSON.

curl -i https://api.gifly.jp/v1/searches?tags=foobar

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 12 Oct 2012 23:33:14 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Status: 200 OK
ETag: "a00049ba79152d03380c34652f2cb612"
X-Gifly-Media-Type: gifly.v1

Content-Length: 100
Cache-Control: max-age=0, private, must-revalidate

All the timestamps are returned in the ISO 8601 format.

YYYY-MM-DDTHH:MM:SSZ

Client Errors

In case of the client error, the status code 400 is returned.

Main causes of the error 400

  • Broken JSON was sent. (Parse Error)(Parse Error)
  • Invalid JSON value was sent. (Validation Error) Example: More than 5 tags were sent in searchs api.

Error format

Only one following type is currently available.

HTTP/1.1 400 Bad Request
Content-Length: 38

{"message":"here is an error message"}

HTTP Verbs

Name Description
GET Used for searching/retrieving a resource.
POST Used for creating a resource.
PATCH Used for modifying a part of a resource.
PUT Used for replaying a resource or a collection.
DELETE Used for deleting a resource.

Authentication

Authentication is not currently supported.

GIF Search API

List Searched Gifs

Returns a GIFs List matched to the search query as a response.

GET /searches

Parameters

Name Type Description
tags array of string Input a complete tag name.You can search multiple tags separated by commas. (Up to 5) (Cannot be used together with *q.)
q string Input a URLEncoded search keyword.
This keyword works as a tag prefix search.
Gifly allows the use of hiragana or katakana to search for a tag including alphabets or Chinese characters.
(Example: A GIF including a tag such as ‘Star Wars’ or ‘Star trek’ can be searched by q=star.(Cannot be used together with *tags.)

Advanced search
・OR search: can be done by connecting keywords using +OR+ (E.g. q=a+OR+b)
page integer Page number

[]( | sort | integer | The key used for sorting.

List of available keys
・score
・created_at | | direction | string | Specify sort order from asc or desc. )

Response

Example

curl -H 'Accept: application/json;' https://api.gifly.jp/v1/searches?q=shark&page=2
Status: 200 OK
{
  "total_count": 2,
  "items": [
    {
      "id": "d25e5b51-7d9f-11e6-b2e3-6d612654d530",
      "user_id": 1,
      "image": "https://gifly.jp/gifs/96504291-9929-11e6-aee9-dfdc2f6b25ef",
      "poster_image": {
        "large":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/large/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "medium":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/medium/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "small":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/small/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "square":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/square/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg"
      },
      "poster_image_content_type": "image\/jpeg",
      "category_id": 1,
      "child_category_id": 1,
      "source_url": "https:\/\/www.youtube.com\/watch?v=foobar",
      "duration": 3,
      "created_at": "2016-09-18T13:00:09.000Z",
      "updated_at": "2016-09-18T13:00:09.000Z",
      "tags": [
        {
          "id": 1,
          "name": "shark"
        },
        {
          "id": 2,
          "name": "planet"
        }
      ]
    }
  ]
}

Overview

ここでは、Gifly API V1リソースに関する基本的なことを記載しています。

Current Version

現在のGifly APIのデフォルトバージョンは、V1です。

Schema

全てのAPIはhttps://api.gifly.jpにアクセスする必要があります。 データフォーマットはJSON形式となります。

curl -i https://api.gifly.jp/v1/searches?tags=foobar

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 12 Oct 2012 23:33:14 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Status: 200 OK
ETag: "a00049ba79152d03380c34652f2cb612"
X-Gifly-Media-Type: gifly.v1

Content-Length: 100
Cache-Control: max-age=0, private, must-revalidate

全てのタイムスタンプはISO 8601 形式で返答されます。

YYYY-MM-DDTHH:MM:SSZ

Client Errors

クライアントエラーの際は、400をステータスコードとしてレスポンスを返答します。

400エラーが返る主な原因

  • 壊れたJSONを送信した(Parse Error)
  • 仕様と異なるJSON値を送信した(Validation Error) (例. searchs apiで、tagsを5個以上送信してしまった場合など。

エラーのフォーマット

現在は、下記の一種類のみとなります。

HTTP/1.1 400 Bad Request
Content-Length: 38

{"message":"here is an error message"}

HTTP Verbs

Name Description
GET リソースを検索/取得する際に使用します
POST リソースを作成する際に使用します。
PATCH リソースの一部を更新する際に使用します。
PUT リソース、またはコレクションをリプレイする際に使用します。
DELETE リソースを削除する際に利用します。

Authentication

現在はAuthenticationはサポートしていません。

GIF Search API

List Searched Gifs

検索クエリにマッチしたGIFs Listをレスポンスとして返します。

GET /searches

Parameters

Name Type Description
tags array of string 完全なタグ名を入力します。カンマ区切りで複数タグを検索可能です。(最大5個) (*qとの併用はできません)
q string URLEncode済みの検索キーワードを入力します。
このキーワードはタグの前方一致検索として機能します。
Giflyではアルファベットや漢字を含むタグもひらがな、カタカナで検索可能です。
(例 Star Wars, Star trekというタグを含むGIFは、q=スターで取得可能。 (*tagsとの併用はできません)

高度な検索
・OR検索: q=a+OR+bと、+OR+でキーワード同士を繋ぐことでOR検索を行うことが出来ます。
page integer ページ番号

[]( | sort | integer | ソートに使用するキーです。

利用可能なキーの一覧
・score
・created_at | | direction | string | ソートオーダーをasc or descから指定します。 )

Response

Example

curl -H 'Accept: application/json;' https://api.gifly.jp/v1/searches?q=shark&page=2
Status: 200 OK
{
  "total_count": 2,
  "items": [
    {
      "id": "d25e5b51-7d9f-11e6-b2e3-6d612654d530",
      "user_id": 1,
      "image": "https://gifly.jp/gifs/96504291-9929-11e6-aee9-dfdc2f6b25ef",
      "poster_image": {
        "large":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/large/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "medium":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/medium/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "small":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/small/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg",
        "square":"https://cdn.gifly.jp/gif_poster_images/96504291-9929-11e6-aee9-dfdc2f6b25ef/square/966d8e90-9929-11e6-aee9-dfdc2f6b25ef.jpg"
      },
      "poster_image_content_type": "image\/jpeg",
      "category_id": 1,
      "child_category_id": 1,
      "source_url": "https:\/\/www.youtube.com\/watch?v=foobar",
      "duration": 3,
      "created_at": "2016-09-18T13:00:09.000Z",
      "updated_at": "2016-09-18T13:00:09.000Z",
      "tags": [
        {
          "id": 1,
          "name": "shark"
        },
        {
          "id": 2,
          "name": "planet"
        }
      ]
    }
  ]
}
You can’t perform that action at this time.