ナビゲーションにスキップ
BeatAPICore

Call a social data endpoint

Calls one catalogued social data action through BeatAPI. The supplier is never part of the public contract. Use the action catalog published by BeatAPI and pass scalar query parameters for GET actions or a JSON object for POST actions.

認証

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

リクエスト

This endpoint expects an object.
actionstring必須形式: "^[a-z0-9]+(?:[._-][a-z0-9]+)+$"

BeatAPI action ID from the public social-data catalog.

paramsmap from strings to anyオプション

レスポンス

Synchronous social data result.
objectenum
許可された値:
statusenum
許可された値:
actionstring
request_idstring
datamap from strings to any

エラー

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error