Postman 시작하기

이 튜토리얼에서는 Postman이 무엇인지와 빠르게 설정하는 방법을 알아봅니다.

​

소개

Postman은 그래픽 사용자 인터페이스에서 API에 요청을 보낼 수 있는 데스크톱 및 웹 애플리케이션입니다. API의 기능을 탐색하거나 애플리케이션 문제를 해결할 때 X API, X Ads API, 그리고 Labs 엔드포인트와 함께 Postman 사용을 권장합니다.

현재 두 가지 Postman 컬렉션을 제공하고 있습니다:

X API v2 Collection

X Ads API Collection

​

사전 준비 사항

X의 Postman 컬렉션을 사용하기 전에, 사용하려는 X 개발자 플랫폼 도구에 필요한 액세스 권한과 자격 증명이 있는지 확인해야 합니다. 액세스 권한 획득 방법은 “시작하기” 페이지에서 확인할 수 있습니다.

개발자 계정을 보유하고, Developer 앱을 설정했으며, 인증 키와 토큰을 발급받고, 사용하려는 특정 API에 요청을 보낼 수 있도록 환경을 올바르게 구성했다면, 아래 단계에 따라 시작할 수 있습니다.  

​

X의 Postman 컬렉션으로 시작하기

​

1단계: X Postman 컬렉션 중 하나를 계정에 추가하세요

Postman에서 사용할 특정 엔드포인트를 직접 구성할 수도 있지만, 저희가 이미 필요한 작업을 모두 마쳐 바로 사용할 수 있는 관련 API 컬렉션을 준비해 두었습니다. 앞의 “Postman 컬렉션” 섹션에서 링크 중 하나를 클릭하면, 선택한 API와 연동된 모든 엔드포인트가 포함된 컬렉션이 Postman 앱에 추가됩니다. 이 컬렉션은 Postman API network에서도 확인할 수 있습니다. 각 엔드포인트에는 사용 가능한 매개변수, 예시 응답, 인증 유형이 자동으로 포함되어 있으므로, 자격 증명과 매개변수 값만 추가하면 바로 기능을 살펴볼 수 있습니다.

이 예시에서는 X API v2 컬렉션을 사용하겠습니다.   

​

2단계: 키와 토큰을 환경 변수로 추가하기

컬렉션을 Postman 인스턴스에 추가하면 자동으로 ‘X API v2’라는 환경이 생성되며, 여기에 키와 토큰을 추가해야 합니다. 이 단계에서는 Developer 앱에서 발급받은 키와 토큰을 ‘X API v2’ 환경에 추가하는 과정을 안내합니다. 

“X API v2” 환경에 키와 토큰을 추가하려면 Postman 우측 상단의 “manage environments” 버튼을 클릭하세요. 또는 우측 상단의 설정 버튼을 클릭해도 됩니다.   

환경 목록에서 “X API v2”를 클릭합니다. 

다음으로, Apps 대시보드에서 생성한 각 키와 토큰에 해당하는 변수를 추가해 표에 입력합니다. 아래는 표의 예시입니다:

VARIABLE	INITIAL VALUE	CURRENT VALUE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

위 표의 키와 토큰은 예시용 임의 값이므로 실제 요청에 사용해도 동작하지 않습니다. 

자격 증명을 변수로 추가하고 X API v2 환경이 선택되어 있는지 확인했다면, 이제 X API v2 컬렉션으로 요청을 보낼 준비가 된 것입니다. 이는 각 엔드포인트의 인증 탭이 이 환경의 변수를 자동으로 상속하도록 설정되어 있기 때문입니다. 

Postman에서 사용자 액세스 토큰을 사용하는 방법은 XXXX로 이동해 추가 정보를 확인하세요.

​

3단계: 엔드포인트 선택 

이제 컬렉션에서 엔드포인트를 선택하고 요청 작성을 시작합니다. 오른쪽 탐색 영역에서 엔드포인트를 선택할 수 있습니다. 화면은 다음과 같습니다:

이 예에서는 X API v2 > Post Lookup > Single Post 엔드포인트를 사용하겠습니다. 

​

4단계: Params 탭에 값 추가

다음으로 Params 탭으로 이동합니다. 비활성화된 여러 파라미터와 각 파라미터의 기능을 설명하는 설명, 그리고 요청과 함께 전달할 수 있는 가능한 값들의 목록이 표시됩니다. 

이 예제에서는 expansions 및 tweet.fields 쿼리 파라미터를 활성화하고 다음 값을 추가합니다:

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

쿼리 파라미터 추가 외에도 필수 Path Variable인 id를 추가해야 합니다. 이 엔드포인트는 게시물을 반환하므로 값으로 유효한 게시물 ID를 넣어야 합니다.

x.com에서 게시물을 클릭한 뒤 URL에서 게시물 ID를 확인할 수 있습니다. 예를 들어, 다음 URL의 게시물 ID는 1228393702244134912입니다:

https://x.com/XDevelopers/status/1228393702244134912

Params 탭에서 모든 쿼리 파라미터를 지나 아래로 스크롤해 “Path Variables” 섹션을 표시합니다. 여기에서 사용할 게시물 ID를 id 키의 값으로 추가합니다.

이 단계의 모든 항목을 정확히 입력했다면 Params 탭은 다음과 같이 표시됩니다:

​

5단계: 요청 보내기 및 응답 검토

이제 요청 설정이 모두 완료되었으므로 “Send” 버튼을 클릭하세요.

모든 설정이 올바르게 구성되었다면 다음과 같은 페이로드를 받게 됩니다.

{
    "data": {
        "author_id": "2244994945",
        "text": "개발자가 발렌타인데이 카드에 뭐라고 썼을까요?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "개발자",
                "id": "2244994945"
            }
        ]
    }
}

​

Postman으로 사용자 액세스 토큰 발급하기:

​

OAuth 1.0a를 사용해 사용자 액세스 토큰 생성하기

OAuth 1.0a 플로우 테스트 컬렉션에 사용된 3단계 프로세스를 검토하세요.

​

OAuth 2.0을 사용하여 사용자 액세스 토큰 생성하기

Postman에서 OAuth 2.0 사용자 액세스 토큰을 생성하려면 X API v2 Postman collection과 함께 사용할 OAuth 2.0 액세스 토큰을 만들 수 있습니다. 

워크스페이스에서 컬렉션을 클릭한 뒤 “Auth” 탭으로 이동하여 유형을 “OAuth 2.0”으로 선택합니다. 이어서 “Configure New Token” 섹션의 “Configuration Options”로 이동합니다. 여기서 “Grant Type”을 “Authorization Code (With PKCE)”로 설정할 수 있습니다.

Callback URL을 애플리케이션에 설정된 callback url과 일치하도록 업데이트하세요. 또한 다음 매개변수도 업데이트해야 합니다:

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - Dev Portal에서 발급받은 OAuth 2.0 client ID
• Client Secret - 기밀 클라이언트를 사용하는 경우
• Scope 업데이트 - 연결하려는 엔드포인트에 맞춘 스코프. 예: “tweet.read users.read” 
• Callback URL(redirect URL이라고도 함). App의 인증 설정에 설정된 값과 일치해야 합니다.
• State - state

준비가 되면 “Get New Access Token”을 클릭하여 액세스 토큰을 생성하세요. 문제가 발생했다는 대화상자가 보이면 로그인하기 위해 뒤로 가기 버튼을 눌러야 할 수 있습니다. 대화상자에서 “Authorize app”을 클릭해 앱이 계정에 접근하도록 승인해야 합니다.

앱을 승인하면 Postman으로 돌아가 토큰을 확인하고 “Use Token” 버튼을 선택하여 승인된 사용자를 대신해 요청을 보내기 시작할 수 있습니다.

이제 Postman 컬렉션을 사용할 준비가 되었습니다.

​

다음 단계

Postman에서 “Code” 버튼을 클릭하면 방금 만든 요청을 Python, Node, Ruby 등 원하는 언어로 변환해 바로 시작할 수 있습니다. Postman에는 참고할 만한 우수한 문서가 있습니다. 또한 엔드포인트와 더 빠르게 연동하는 데 도움이 되는 GitHub의 샘플 코드도 제공하고 있습니다.