🌞The REST API documentations of the ALIS.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

ALIS APIドキュメント

ALIS

ALISが公開するAPIについてのドキュメントです。

APIエンドポイントの詳細情報

利用方法

API利用方法を記載します。 このドキュメントでは以下の環境で動作確認をしています。

  • macOS High Sierra

人気記事の一覧を取得する例

人気記事の一覧を1件取得するリクエストを例にして利用方法を説明します。

該当APIエンドポイント

コマンド

curl -X GET "https://alis.to/api/articles/popular?limit=1" -H "accept: application/json"

レスポンス

{"Items": [{"user_id": "moukonjoshi", "created_at": 1529964744, "overview": "\u306f\u3044\u304a\u306f\u3088\u3046\u3054\u3056\u3044\u307e\u3059\u3081\u3061\u3083\u7720\u3044\u3067\u304a\u99b4\u67d3\u307f\u6bdb\u6839\u5973\u5b50\u3067\u3054\u3056\u3044\u307e\u3059\u3055\u3042\u3066\u3055\u3066\u4eca\u65e5\u671d\u5bb6\u3067\u308b\u524d\u306b\u30ab\u30d0\u30f3\u304c\u30d1\u30f3\u30d1\u30f3\u3060\u3063\u305f\u306e\u3067\u3044\u3089\u306a\u3044\u3082\u306e\u3092\u6368\u3066\u3066\u3044\u305f\u3093\u3067\u3059\u306d\u3059\u308b\u3068\u4e2d\u304b\u3089\u4f55\u6545\u304b\u5927\u91cf\u306e\u7c73\u304c\u3067\u3066\u304d\u305f\u3093\u3067\u3059\u3088\u306a\u3093\u304b\u306e\u546a", "status": "public", "eye_catch_url": "https://alis.to/d/api/articles_images/moukonjoshi/2APOAezNXzNr/08ecbd59-af46-4937-84ca-240f3831ada3.png", "sort_key": 1529965459183534, "article_id": "2APOAezNXzNr", "published_at": 1529965459, "title": "\u6bdb\u6839\u4f8d\u7b2c2\u90e81\u8a71\u30d3\u30c3\u30c8\u30b3\u30a4\u30f3\u30c1\u30e5\u30a6"}], "LastEvaluatedKey": {"evaluated_at": 1529993420358003, "article_id": "2APOAezNXzNr", "score": 51}}

※日本語などのマルチバイト文字はUnicode Escape Sequenceでエンコードされているためデコードする必要があります。

コマンドの作成

ドキュメントの該当箇所で以下のように操作すると上記で使用したコマンドが作成できます。 articles_popular

SDK

コミュニティ作成のSDKが存在します。

コミュニティ

  • 公式Discord
    • ALIS公式のDiscordコミュニティです。
  • ALIS Supporters
    • 非公式Discordコミュニティ。#ハッカー部 という部屋があります。

API利用における注意事項

  • ALIS利用規約の範囲内で利用してください
  • 現状は特にリクエスト回数の制限等はありません
    • しかし過大な負荷や悪意あるリクエストが多発するなどした場合には制限を設ける予定です
  • CORSは許可していません
    • 他ドメインのフロントエンドからのAPI利用はできません
  • フィードバックは公式Discordへよろしくお願いします
  • 本ドキュメントのライセンス: CC4