페이지 이동경로
  • Docs>
  • Tool>
  • REST API test

Tool

Test tool

This document introduces the webhook test feature provided by Kakao Developers.

Overview

Kakao Developers provides a REST API test tool for testing and developing with a REST API or debugging.

You can test API calls in [Tools] > [REST API Test].

Description

Composition of REST API test tool

🅐 API List: Select one of the APIs to test. 🅑 App: [developers-sample] is set as default, select another test app by clicking the list icon next to the app name. 🅒 API information: Describes the feature of selected API. 🅓 Authentication: Select an authentication method between an access token or the app's admin key, an access token will be issued when clicking [Issue token]. 🅔 Parameter: Set the request parameter values.

Specifications in REST API test tool

🅕 Request: Describes the request parameters of the selected API. 🅖 Response: Describes the keys and values in response of selected API.

Response example in REST API test tool

🅗 Response example: Shows the examples of the response.

How to use

  1. Select the authentication method. You can use either an access token or an admin key. If you choose an access token, you can select the scope of user information the token allows you to access.
  2. Set the parameters to be sent with the request. Parameters marked with * are required.
  3. Click [Send] to make the API request with your configured settings.

You can view the request example and the corresponding response.

Response and request example in REST API test tool

🅘 HTTP status code: Shows the HTTP status code in response. Refer to Response code. 🅙 Response body: Shows the response body in response 🅚 Response code example: A request code example for a test in the actual development environment.